diff --git a/linkinator.config.json b/linkinator.config.json index d780d6bfff5..b28554d6bda 100644 --- a/linkinator.config.json +++ b/linkinator.config.json @@ -2,6 +2,7 @@ "recurse": true, "skip": [ "https://codecov.io/gh/googleapis/", - "www.googleapis.com" + "www.googleapis.com", + "david-dm.org/+" ] } diff --git a/src/apis/abusiveexperiencereport/package.json b/src/apis/abusiveexperiencereport/package.json index 241d0f49191..80a0b69a244 100644 --- a/src/apis/abusiveexperiencereport/package.json +++ b/src/apis/abusiveexperiencereport/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.2", - "typescript": "~3.5.0", - "webpack": "^4.31.0", - "webpack-cli": "^3.3.2" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/abusiveexperiencereport/webpack.config.js b/src/apis/abusiveexperiencereport/webpack.config.js index 69b85d471b5..4430218801c 100644 --- a/src/apis/abusiveexperiencereport/webpack.config.js +++ b/src/apis/abusiveexperiencereport/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/acceleratedmobilepageurl/package.json b/src/apis/acceleratedmobilepageurl/package.json index e00c3e32256..6d53dc0ccc0 100644 --- a/src/apis/acceleratedmobilepageurl/package.json +++ b/src/apis/acceleratedmobilepageurl/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/acceleratedmobilepageurl/webpack.config.js b/src/apis/acceleratedmobilepageurl/webpack.config.js index 109e3ee42d1..ccd10c45aab 100644 --- a/src/apis/acceleratedmobilepageurl/webpack.config.js +++ b/src/apis/acceleratedmobilepageurl/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/accessapproval/package.json b/src/apis/accessapproval/package.json index ac54a3eab86..bdd417bf1c7 100644 --- a/src/apis/accessapproval/package.json +++ b/src/apis/accessapproval/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/accessapproval/webpack.config.js b/src/apis/accessapproval/webpack.config.js index a612f5ce6f6..d4fa20f131e 100644 --- a/src/apis/accessapproval/webpack.config.js +++ b/src/apis/accessapproval/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/accesscontextmanager/package.json b/src/apis/accesscontextmanager/package.json index e0473aebeca..6d28c257613 100644 --- a/src/apis/accesscontextmanager/package.json +++ b/src/apis/accesscontextmanager/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/accesscontextmanager/v1.ts b/src/apis/accesscontextmanager/v1.ts index 4d75e71d0a8..d88565ee036 100644 --- a/src/apis/accesscontextmanager/v1.ts +++ b/src/apis/accesscontextmanager/v1.ts @@ -397,7 +397,7 @@ export namespace accesscontextmanager_v1 { restrictedServices?: string[]; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -1193,7 +1193,7 @@ export namespace accesscontextmanager_v1 { * * @param {object} params Parameters for request * @param {string} params.name Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}` - * @param {string=} params.updateMask Required. Mask to control which fields get updated. Must be non-empty. + * @param {string=} params.updateMask Required. Mask to control which fields get updated. Must be non-empty. * @param {().AccessLevel} 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. @@ -1341,7 +1341,7 @@ export namespace accesscontextmanager_v1 { */ name?: string; /** - * Required. Mask to control which fields get updated. Must be non-empty. + * Required. Mask to control which fields get updated. Must be non-empty. */ updateMask?: string; diff --git a/src/apis/accesscontextmanager/v1beta.ts b/src/apis/accesscontextmanager/v1beta.ts index 73b3cb041dd..73da59358a2 100644 --- a/src/apis/accesscontextmanager/v1beta.ts +++ b/src/apis/accesscontextmanager/v1beta.ts @@ -186,6 +186,19 @@ export namespace accesscontextmanager_v1beta { */ conditions?: Schema$Condition[]; } + /** + * Alpha. Specifies which services are granted access via this Bridge Service Perimeter. + */ + export interface Schema$BridgeServiceRestriction { + /** + * The list of APIs usable through the Bridge Perimeter. Must be empty unless 'enable_restriction' is True. + */ + allowedServices?: string[]; + /** + * Whether to restrict the set of APIs callable through the Bridge Service Perimeter. + */ + enableRestriction?: boolean; + } /** * A condition necessary for an `AccessLevel` to be granted. The Condition is an AND over its fields. So a Condition is true if: 1) the request IP is from one of the listed subnetworks AND 2) the originating device complies with the listed device policy AND 3) all listed access levels are granted AND 4) the request was sent at a time allowed by the DateTimeRestriction. */ @@ -244,6 +257,19 @@ export namespace accesscontextmanager_v1beta { */ requireScreenlock?: boolean; } + /** + * Alpha. Specifies how Access Levels are to be used for accessing the Service Perimeter. + */ + export interface Schema$IngressServiceRestriction { + /** + * The list of APIs usable with a valid Access Level. Must be empty unless 'enable_restriction' is True. + */ + allowedServices?: string[]; + /** + * Whether to restrict the set of APIs callable outside the Service Perimeter via Access Levels. + */ + enableRestriction?: boolean; + } /** * A response to `ListAccessLevelsRequest`. */ @@ -366,6 +392,14 @@ export namespace accesscontextmanager_v1beta { * A list of `AccessLevel` resource names that allow resources within the `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must be in the same policy as this `ServicePerimeter`. Referencing a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. */ accessLevels?: string[]; + /** + * Alpha. Configuration for what services are accessible via the Bridge Perimeter. Must be empty for non-Bridge Perimeters. + */ + bridgeServiceRestriction?: Schema$BridgeServiceRestriction; + /** + * Alpha. Configuration for which services may be used with Access Levels. + */ + ingressServiceRestriction?: Schema$IngressServiceRestriction; /** * A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}` */ @@ -378,9 +412,13 @@ export namespace accesscontextmanager_v1beta { * GCP services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted. */ unrestrictedServices?: string[]; + /** + * Alpha. Configuration for within Perimeter allowed APIs. + */ + vpcServiceRestriction?: Schema$VpcServiceRestriction; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -396,6 +434,19 @@ export namespace accesscontextmanager_v1beta { */ message?: string; } + /** + * Alpha. Specifies how APIs are allowed to communicate within the Service Perimeter. + */ + export interface Schema$VpcServiceRestriction { + /** + * The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. + */ + allowedServices?: string[]; + /** + * Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'. + */ + enableRestriction?: boolean; + } export class Resource$Accesspolicies { context: APIRequestContext; @@ -1182,7 +1233,7 @@ export namespace accesscontextmanager_v1beta { * * @param {object} params Parameters for request * @param {string} params.name Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}` - * @param {string=} params.updateMask Required. Mask to control which fields get updated. Must be non-empty. + * @param {string=} params.updateMask Required. Mask to control which fields get updated. Must be non-empty. * @param {().AccessLevel} 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. @@ -1330,7 +1381,7 @@ export namespace accesscontextmanager_v1beta { */ name?: string; /** - * Required. Mask to control which fields get updated. Must be non-empty. + * Required. Mask to control which fields get updated. Must be non-empty. */ updateMask?: string; diff --git a/src/apis/accesscontextmanager/webpack.config.js b/src/apis/accesscontextmanager/webpack.config.js index ab891bcfa05..cc8f3c2c204 100644 --- a/src/apis/accesscontextmanager/webpack.config.js +++ b/src/apis/accesscontextmanager/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/adexchangebuyer/package.json b/src/apis/adexchangebuyer/package.json index 1c48f3cb2fd..eda30f11bdb 100644 --- a/src/apis/adexchangebuyer/package.json +++ b/src/apis/adexchangebuyer/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/adexchangebuyer/v1.3.ts b/src/apis/adexchangebuyer/v1.3.ts index 08e9d4845ea..b64bc08f98f 100644 --- a/src/apis/adexchangebuyer/v1.3.ts +++ b/src/apis/adexchangebuyer/v1.3.ts @@ -238,6 +238,10 @@ export namespace adexchangebuyer_v1_3 { * Account id. */ accountId?: number; + adTechnologyProviders?: { + detectedProviderIds?: string[]; + hasUnidentifiedProvider?: boolean; + }; /** * Detected advertiser id, if any. Read-only. This field should not be set in requests. */ @@ -312,7 +316,6 @@ export namespace adexchangebuyer_v1_3 { logo?: {height?: number; url?: string; width?: number}; price?: string; starRating?: number; - store?: string; }; /** * Detected product categories, if any. Read-only. This field should not be set in requests. diff --git a/src/apis/adexchangebuyer/v1.4.ts b/src/apis/adexchangebuyer/v1.4.ts index 056b4938c5b..46c2e710ecf 100644 --- a/src/apis/adexchangebuyer/v1.4.ts +++ b/src/apis/adexchangebuyer/v1.4.ts @@ -324,6 +324,10 @@ export namespace adexchangebuyer_v1_4 { * The link to the Ad Preferences page. This is only supported for native ads. */ adChoicesDestinationUrl?: string; + adTechnologyProviders?: { + detectedProviderIds?: string[]; + hasUnidentifiedProvider?: boolean; + }; /** * Detected advertiser id, if any. Read-only. This field should not be set in requests. */ @@ -420,7 +424,6 @@ export namespace adexchangebuyer_v1_4 { logo?: {height?: number; url?: string; width?: number}; price?: string; starRating?: number; - store?: string; videoURL?: string; }; /** diff --git a/src/apis/adexchangebuyer/webpack.config.js b/src/apis/adexchangebuyer/webpack.config.js index e41f26851cb..68d531fb728 100644 --- a/src/apis/adexchangebuyer/webpack.config.js +++ b/src/apis/adexchangebuyer/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/adexchangebuyer2/README.md b/src/apis/adexchangebuyer2/README.md index 86a2188d751..97d7b46cb9b 100644 --- a/src/apis/adexchangebuyer2/README.md +++ b/src/apis/adexchangebuyer2/README.md @@ -2,7 +2,7 @@ # adexchangebuyer2 -> Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals. +> Accesses the latest features for managing Authorized Buyers accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals. ## Installation diff --git a/src/apis/adexchangebuyer2/package.json b/src/apis/adexchangebuyer2/package.json index 9397c0911b9..6afebf4e22f 100644 --- a/src/apis/adexchangebuyer2/package.json +++ b/src/apis/adexchangebuyer2/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/adexchangebuyer2/v2beta1.ts b/src/apis/adexchangebuyer2/v2beta1.ts index d730f368208..e42b7f4c8bc 100644 --- a/src/apis/adexchangebuyer2/v2beta1.ts +++ b/src/apis/adexchangebuyer2/v2beta1.ts @@ -176,6 +176,19 @@ export namespace adexchangebuyer2_v2beta1 { */ width?: string; } + /** + * Detected ad technology provider information. + */ + export interface Schema$AdTechnologyProviders { + /** + * The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction. + */ + detectedProviderIds?: string[]; + /** + * Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction. + */ + hasUnidentifiedProvider?: boolean; + } /** * Output only. The app type the restriction applies to for mobile device. */ @@ -399,6 +412,10 @@ export namespace adexchangebuyer2_v2beta1 { * The link to AdChoices destination page. */ adChoicesDestinationUrl?: string; + /** + * Output only. The detected ad technology providers. + */ + adTechnologyProviders?: Schema$AdTechnologyProviders; /** * The name of the company being advertised in the creative. */ diff --git a/src/apis/adexchangebuyer2/webpack.config.js b/src/apis/adexchangebuyer2/webpack.config.js index 2f4514e1e91..9256de1a0a8 100644 --- a/src/apis/adexchangebuyer2/webpack.config.js +++ b/src/apis/adexchangebuyer2/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/adexperiencereport/package.json b/src/apis/adexperiencereport/package.json index 11cdde6c3cf..faf23ec6f4e 100644 --- a/src/apis/adexperiencereport/package.json +++ b/src/apis/adexperiencereport/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/adexperiencereport/webpack.config.js b/src/apis/adexperiencereport/webpack.config.js index e1601945c1e..f48a7be858b 100644 --- a/src/apis/adexperiencereport/webpack.config.js +++ b/src/apis/adexperiencereport/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index 0440d9a5583..9e3de9e8745 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -471,7 +471,7 @@ export namespace admin_directory_v1 { */ id?: string; /** - * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". + * Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". */ kind?: string; /** diff --git a/src/apis/admin/package.json b/src/apis/admin/package.json index 6d9b22e2136..3bc8047ee98 100644 --- a/src/apis/admin/package.json +++ b/src/apis/admin/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/admin/reports_v1.ts b/src/apis/admin/reports_v1.ts index 1bbca1bb44d..04d803a496e 100644 --- a/src/apis/admin/reports_v1.ts +++ b/src/apis/admin/reports_v1.ts @@ -157,7 +157,9 @@ export namespace admin_reports_v1 { parameters?: Array<{ boolValue?: boolean; intValue?: string; + messageValue?: {parameter?: Schema$NestedParameter[]}; multiIntValue?: string[]; + multiMessageValue?: Array<{parameter?: Schema$NestedParameter[]}>; multiValue?: string[]; name?: string; value?: string; @@ -203,7 +205,7 @@ export namespace admin_reports_v1 { */ id?: string; /** - * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". + * Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". */ kind?: string; /** @@ -231,6 +233,39 @@ export namespace admin_reports_v1 { */ type?: string; } + /** + * JSON template for a parameter used in various reports. + */ + export interface Schema$NestedParameter { + /** + * Boolean value of the parameter. + */ + boolValue?: boolean; + /** + * Integral value of the parameter. + */ + intValue?: string; + /** + * Multiple boolean values of the parameter. + */ + multiBoolValue?: boolean[]; + /** + * Multiple integral values of the parameter. + */ + multiIntValue?: string[]; + /** + * Multiple string values of the parameter. + */ + multiValue?: string[]; + /** + * The name of the parameter. + */ + name?: string; + /** + * String value of the parameter. + */ + value?: string; + } /** * JSON template for a usage report. */ diff --git a/src/apis/admin/webpack.config.js b/src/apis/admin/webpack.config.js index d46c98da5cf..7f512c6ce10 100644 --- a/src/apis/admin/webpack.config.js +++ b/src/apis/admin/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/adsense/package.json b/src/apis/adsense/package.json index a90cd352819..698090de4cf 100644 --- a/src/apis/adsense/package.json +++ b/src/apis/adsense/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/adsense/webpack.config.js b/src/apis/adsense/webpack.config.js index 05df66538cc..5a59268382f 100644 --- a/src/apis/adsense/webpack.config.js +++ b/src/apis/adsense/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/adsensehost/package.json b/src/apis/adsensehost/package.json index 6a20d12cd03..c626882045b 100644 --- a/src/apis/adsensehost/package.json +++ b/src/apis/adsensehost/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/adsensehost/webpack.config.js b/src/apis/adsensehost/webpack.config.js index 0ed8baf8f0d..601ff07fefd 100644 --- a/src/apis/adsensehost/webpack.config.js +++ b/src/apis/adsensehost/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/alertcenter/package.json b/src/apis/alertcenter/package.json index 98b9c5dcc59..d1fdca94ec2 100644 --- a/src/apis/alertcenter/package.json +++ b/src/apis/alertcenter/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/alertcenter/v1beta1.ts b/src/apis/alertcenter/v1beta1.ts index e4f5ed1f2dd..6018e4daf28 100644 --- a/src/apis/alertcenter/v1beta1.ts +++ b/src/apis/alertcenter/v1beta1.ts @@ -518,6 +518,10 @@ export namespace alertcenter_v1beta1 { * Entity whose actions triggered a Gmail phishing alert. */ export interface Schema$MaliciousEntity { + /** + * The header from display name. + */ + displayName?: string; /** * The sender email address. */ diff --git a/src/apis/alertcenter/webpack.config.js b/src/apis/alertcenter/webpack.config.js index 962cc526821..863db2c7441 100644 --- a/src/apis/alertcenter/webpack.config.js +++ b/src/apis/alertcenter/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/analytics/package.json b/src/apis/analytics/package.json index b1c41dbb6d4..c98dd4f48c1 100644 --- a/src/apis/analytics/package.json +++ b/src/apis/analytics/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/analytics/v3.ts b/src/apis/analytics/v3.ts index b75c109875d..a8d7cc597d1 100644 --- a/src/apis/analytics/v3.ts +++ b/src/apis/analytics/v3.ts @@ -2358,7 +2358,7 @@ export namespace analytics_v3 { */ created?: string; /** - * Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period). Set to false to delete data associated with the user identifer automatically after the rentention period. This property cannot be set on insert. + * Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period). Set to false to delete data associated with the user identifier automatically after the rentention period. This property cannot be set on insert. */ dataRetentionResetOnNewActivity?: boolean; /** @@ -5519,7 +5519,7 @@ export namespace analytics_v3 { /** * analytics.management.filters.get - * @desc Returns a filters to which the user has access. + * @desc Returns filters to which the user has access. * @alias analytics.management.filters.get * @memberOf! () * diff --git a/src/apis/analytics/webpack.config.js b/src/apis/analytics/webpack.config.js index 300936d4502..ae4eb017da6 100644 --- a/src/apis/analytics/webpack.config.js +++ b/src/apis/analytics/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/analyticsreporting/package.json b/src/apis/analyticsreporting/package.json index 244315476e9..cdb632cc1ec 100644 --- a/src/apis/analyticsreporting/package.json +++ b/src/apis/analyticsreporting/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/analyticsreporting/v4.ts b/src/apis/analyticsreporting/v4.ts index d7e38d37e40..780b638978c 100644 --- a/src/apis/analyticsreporting/v4.ts +++ b/src/apis/analyticsreporting/v4.ts @@ -210,7 +210,7 @@ export namespace analyticsreporting_v4 { */ cohorts?: Schema$Cohort[]; /** - * Enable Life Time Value (LTV). LTV measures lifetime value for users acquired through different channels. Please see: [Cohort Analysis](https://support.google.com/analytics/answer/6074676) and [Lifetime Value](https://support.google.com/analytics/answer/6182550) If the value of lifetimeValue is false: - The metric values are similar to the values in the web interface cohort report. - The cohort definition date ranges must be aligned to the calendar week and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in the cohort definition should be a Sunday and the `endDate` should be the following Saturday, and for `ga:cohortNthMonth`, the `startDate` should be the 1st of the month and `endDate` should be the last day of the month. When the lifetimeValue is true: - The metric values will correspond to the values in the web interface LifeTime value report. - The Lifetime Value report shows you how user value (Revenue) and engagement (Appviews, Goal Completions, Sessions, and Session Duration) grow during the 90 days after a user is acquired. - The metrics are calculated as a cumulative average per user per the time increment. - The cohort definition date ranges need not be aligned to the calendar week and month boundaries. - The `viewId` must be an [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews) + * Enable Life Time Value (LTV). LTV measures lifetime value for users acquired through different channels. Please see: [Cohort Analysis](https://support.google.com/analytics/answer/6074676) and [Lifetime Value](https://support.google.com/analytics/answer/6182550) If the value of lifetimeValue is false: - The metric values are similar to the values in the web interface cohort report. - The cohort definition date ranges must be aligned to the calendar week and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in the cohort definition should be a Sunday and the `endDate` should be the following Saturday, and for `ga:cohortNthMonth`, the `startDate` should be the 1st of the month and `endDate` should be the last day of the month. When the lifetimeValue is true: - The metric values will correspond to the values in the web interface LifeTime value report. - The Lifetime Value report shows you how user value (Revenue) and engagement (Appviews, Goal Completions, Sessions, and Session Duration) grow during the 90 days after a user is acquired. - The metrics are calculated as a cumulative average per user per the time increment. - The cohort definition date ranges need not be aligned to the calendar week and month boundaries. - The `viewId` must be an [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews) */ lifetimeValue?: boolean; } diff --git a/src/apis/analyticsreporting/webpack.config.js b/src/apis/analyticsreporting/webpack.config.js index e226b361955..7325f8ef567 100644 --- a/src/apis/analyticsreporting/webpack.config.js +++ b/src/apis/analyticsreporting/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/androiddeviceprovisioning/package.json b/src/apis/androiddeviceprovisioning/package.json index 533571531b5..fcc53f78572 100644 --- a/src/apis/androiddeviceprovisioning/package.json +++ b/src/apis/androiddeviceprovisioning/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/androiddeviceprovisioning/v1.ts b/src/apis/androiddeviceprovisioning/v1.ts index a12c84d0662..f08a6038bcb 100644 --- a/src/apis/androiddeviceprovisioning/v1.ts +++ b/src/apis/androiddeviceprovisioning/v1.ts @@ -169,7 +169,7 @@ export namespace androiddeviceprovisioning_v1 { */ export interface Schema$Company { /** - * Input only. Optional. Email address of customer's users in the admin role. Each email address must be associated with a Google Account. + * Optional. Input only. Email address of customer's users in the admin role. Each email address must be associated with a Google Account. */ adminEmails?: string[]; /** @@ -711,7 +711,7 @@ export namespace androiddeviceprovisioning_v1 { status?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/androiddeviceprovisioning/webpack.config.js b/src/apis/androiddeviceprovisioning/webpack.config.js index 54999d406a1..8068a16b6fe 100644 --- a/src/apis/androiddeviceprovisioning/webpack.config.js +++ b/src/apis/androiddeviceprovisioning/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/androidenterprise/package.json b/src/apis/androidenterprise/package.json index 18cdfa2dc78..4060654573c 100644 --- a/src/apis/androidenterprise/package.json +++ b/src/apis/androidenterprise/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts index 731133e05ab..e3b1778179d 100644 --- a/src/apis/androidenterprise/v1.ts +++ b/src/apis/androidenterprise/v1.ts @@ -327,6 +327,19 @@ export namespace androidenterprise_v1 { */ kind?: string; } + /** + * List of states set by the app. + */ + export interface Schema$AppState { + /** + * List of keyed app states. This field will always be present. + */ + keyedAppState?: Schema$KeyedAppState[]; + /** + * The package name of the app. This field will always be present. + */ + packageName?: string; + } /** * An event generated when a new version of an app is uploaded to Google Play. Notifications are sent for new public versions only: alpha, beta, or canary versions do not generate this event. To fetch up-to-date version history for an app, use Products.Get on the EMM API. */ @@ -446,6 +459,40 @@ export namespace androidenterprise_v1 { * The policy enforced on the device. */ policy?: Schema$Policy; + /** + * The device report updated with the latest app states. + */ + report?: Schema$DeviceReport; + } + /** + * Device report updated with the latest app states for managed apps on the device. + */ + export interface Schema$DeviceReport { + /** + * List of app states set by managed apps on the device. App states are defined by the app's developers. This field will always be present. + */ + appState?: Schema$AppState[]; + /** + * The timestamp of the last report update in milliseconds since epoch. This field will always be present. + */ + lastUpdatedTimestampMillis?: string; + } + /** + * An event generated when an updated device report is available. + */ + export interface Schema$DeviceReportUpdateEvent { + /** + * The Android ID of the device. This field will always be present. + */ + deviceId?: string; + /** + * The device report updated with the latest app states. This field will always be present. + */ + report?: Schema$DeviceReport; + /** + * The ID of the user. This field will always be present. + */ + userId?: string; } /** * The device resources for the user. @@ -682,6 +729,31 @@ export namespace androidenterprise_v1 { */ kind?: string; } + /** + * Represents a keyed app state containing a key, timestamp, severity level, optional description, and optional data. + */ + export interface Schema$KeyedAppState { + /** + * Additional field intended for machine-readable data. For example, a number or JSON object. To prevent XSS, we recommend removing any HTML from the data before displaying it. + */ + data?: string; + /** + * Key indicating what the app is providing a state for. The content of the key is set by the app's developer. To prevent XSS, we recommend removing any HTML from the key before displaying it. This field will always be present. + */ + key?: string; + /** + * Free-form, human-readable message describing the app state. For example, an error message. To prevent XSS, we recommend removing any HTML from the message before displaying it. + */ + message?: string; + /** + * Severity of the app state. This field will always be present. + */ + severity?: string; + /** + * Timestamp of when the app set the state in milliseconds since epoch. This field will always be present. + */ + stateTimestampMillis?: string; + } /** * A localized string with its locale. */ @@ -885,6 +957,10 @@ export namespace androidenterprise_v1 { * Notifications about app updates. */ appUpdateEvent?: Schema$AppUpdateEvent; + /** + * Notifications about device report updates. + */ + deviceReportUpdateEvent?: Schema$DeviceReportUpdateEvent; /** * The ID of the enterprise for which the notification is sent. This will always be present. */ @@ -969,6 +1045,10 @@ export namespace androidenterprise_v1 { * The auto-update policy for apps installed on the device. "choiceToTheUser" allows the device's user to configure the app update policy. "always" enables auto updates. "never" disables auto updates. "wifiOnly" enables auto updates only when the device is connected to wifi. */ autoUpdatePolicy?: string; + /** + * Whether the device reports app states to the EMM. The default value is "deviceReportDisabled". + */ + deviceReportPolicy?: string; /** * The maintenance window defining when apps running in the foreground should be updated. */ @@ -1562,6 +1642,80 @@ export namespace androidenterprise_v1 { this.context = context; } + /** + * androidenterprise.devices.forceReportUpload + * @desc Uploads a report containing any changes in app states on the device since the last report was generated. You can call this method up to 3 times every 24 hours for a given device. + * @alias androidenterprise.devices.forceReportUpload + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.deviceId The ID of the device. + * @param {string} params.enterpriseId The ID of the enterprise. + * @param {string} params.userId The ID of the 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 + */ + forceReportUpload( + params?: Params$Resource$Devices$Forcereportupload, + options?: MethodOptions + ): GaxiosPromise; + forceReportUpload( + params: Params$Resource$Devices$Forcereportupload, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + forceReportUpload( + params: Params$Resource$Devices$Forcereportupload, + callback: BodyResponseCallback + ): void; + forceReportUpload(callback: BodyResponseCallback): void; + forceReportUpload( + paramsOrCallback?: + | Params$Resource$Devices$Forcereportupload + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Devices$Forcereportupload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Devices$Forcereportupload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/forceReportUpload' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['enterpriseId', 'userId', 'deviceId'], + pathParams: ['deviceId', 'enterpriseId', 'userId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * androidenterprise.devices.get * @desc Retrieves the details of a device. @@ -2011,6 +2165,26 @@ export namespace androidenterprise_v1 { } } + export interface Params$Resource$Devices$Forcereportupload + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the device. + */ + deviceId?: string; + /** + * The ID of the enterprise. + */ + enterpriseId?: string; + /** + * The ID of the user. + */ + userId?: string; + } export interface Params$Resource$Devices$Get extends StandardParameters { /** * Auth client or API Key for the request diff --git a/src/apis/androidenterprise/webpack.config.js b/src/apis/androidenterprise/webpack.config.js index 047d52a45a4..dd6f5f491e5 100644 --- a/src/apis/androidenterprise/webpack.config.js +++ b/src/apis/androidenterprise/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/androidmanagement/package.json b/src/apis/androidmanagement/package.json index f72a958d6da..cb7cc4b8e0a 100644 --- a/src/apis/androidmanagement/package.json +++ b/src/apis/androidmanagement/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index b26f7b0eb0d..d7024615083 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -1026,7 +1026,7 @@ export namespace androidmanagement_v1 { */ metadata?: {[key: string]: 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. + * 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 be a resource name ending with operations/{unique_id}. */ name?: string; /** @@ -1191,7 +1191,7 @@ export namespace androidmanagement_v1 { */ choosePrivateKeyRules?: Schema$ChoosePrivateKeyRule[]; /** - * Rules declaring which mitigating actions to take when a device is not compliant with its policy. When the conditions for multiple rules are satisfied, all of the mitigating actions for the rules are taken. There is a maximum limit of 100 rules. + * Rules declaring which mitigating actions to take when a device is not compliant with its policy. When the conditions for multiple rules are satisfied, all of the mitigating actions for the rules are taken. There is a maximum limit of 100 rules. Use policy enforcement rules instead. */ complianceRules?: Schema$ComplianceRule[]; /** @@ -1448,7 +1448,7 @@ export namespace androidmanagement_v1 { */ blockAction?: Schema$BlockAction; /** - * The top-level policy to enforce. For example, applications or passwordRequirements. + * The top-level policy to enforce. For example, applications or passwordPolicies. */ settingName?: string; /** @@ -1587,7 +1587,7 @@ export namespace androidmanagement_v1 { securityPatchLevel?: string; } /** - * 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 needsOverviewThe 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 mappingThe 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 usesThe 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. + * 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). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -1721,7 +1721,7 @@ export namespace androidmanagement_v1 { */ title?: string; /** - * The current version of the app.<p>Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date. + * The current version of the app.Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date. */ versionCode?: string; } @@ -1747,7 +1747,7 @@ export namespace androidmanagement_v1 { */ parentFrameUrl?: string; /** - * Permissions available to an admin in the embedded UI. An admin must have all of these permissions in order to view the UI. + * Permissions available to an admin in the embedded UI. An admin must have all of these permissions in order to view the UI. This field is deprecated. */ permissions?: string[]; /** diff --git a/src/apis/androidmanagement/webpack.config.js b/src/apis/androidmanagement/webpack.config.js index 3b30800504c..1e235b57f76 100644 --- a/src/apis/androidmanagement/webpack.config.js +++ b/src/apis/androidmanagement/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/androidpublisher/package.json b/src/apis/androidpublisher/package.json index f297cd6c033..04b53d49b88 100644 --- a/src/apis/androidpublisher/package.json +++ b/src/apis/androidpublisher/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/androidpublisher/v1.1.ts b/src/apis/androidpublisher/v1.1.ts index 2fc3d6c2429..2a29863a165 100644 --- a/src/apis/androidpublisher/v1.1.ts +++ b/src/apis/androidpublisher/v1.1.ts @@ -124,7 +124,7 @@ export namespace androidpublisher_v1_1 { */ orderId?: string; /** - * The purchase state of the order. Possible values are: - Purchased - Canceled + * The purchase state of the order. Possible values are: - Purchased - Canceled - Pending */ purchaseState?: number; /** diff --git a/src/apis/androidpublisher/v2.ts b/src/apis/androidpublisher/v2.ts index 26c85fe2d03..55cb028ea96 100644 --- a/src/apis/androidpublisher/v2.ts +++ b/src/apis/androidpublisher/v2.ts @@ -547,7 +547,7 @@ export namespace androidpublisher_v2 { */ orderId?: string; /** - * The purchase state of the order. Possible values are: - Purchased - Canceled + * The purchase state of the order. Possible values are: - Purchased - Canceled - Pending */ purchaseState?: number; /** @@ -729,7 +729,7 @@ export namespace androidpublisher_v2 { */ priceCurrencyCode?: string; /** - * The profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. + * The Google profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ profileId?: string; /** @@ -762,7 +762,13 @@ export namespace androidpublisher_v2 { newExpiryTimeMillis?: string; } export interface Schema$Testers { + /** + * A list of all Google Groups, as email addresses, that define testers for this track. + */ googleGroups?: string[]; + /** + * A list of all Google+ Communities, as URLs, that define testers for this track. + */ googlePlusCommunities?: string[]; } export interface Schema$Timestamp { diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index 8fe032dc6ce..356a74241c7 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -480,6 +480,27 @@ export namespace androidpublisher_v3 { */ sha256?: string; } + /** + * Contains the introductory price information for a subscription. + */ + export interface Schema$IntroductoryPriceInfo { + /** + * Introductory price of the subscription, not including tax. The currency is the same as price_currency_code. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000. + */ + introductoryPriceAmountMicros?: string; + /** + * ISO 4217 currency code for the introductory subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP". + */ + introductoryPriceCurrencyCode?: string; + /** + * The number of billing period to offer introductory pricing. + */ + introductoryPriceCycles?: number; + /** + * Introductory price period, specified in ISO 8601 format. Common values are (but not limited to) "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). + */ + introductoryPricePeriod?: string; + } export interface Schema$Listing { /** * Full description of the app; this may be up to 4000 characters in length. @@ -569,7 +590,7 @@ export namespace androidpublisher_v3 { */ orderId?: string; /** - * The purchase state of the order. Possible values are: - Purchased - Canceled + * The purchase state of the order. Possible values are: - Purchased - Canceled - Pending */ purchaseState?: number; /** @@ -692,6 +713,10 @@ export namespace androidpublisher_v3 { * A SubscriptionPurchase resource indicates the status of a user's subscription purchase. */ export interface Schema$SubscriptionPurchase { + /** + * The acknowledgement state of the subscription product. Possible values are: - Yet to be acknowledged - Acknowledged + */ + acknowledgementState?: number; /** * Whether the subscription will automatically be renewed when it reaches its current expiry time. */ @@ -732,6 +757,10 @@ export namespace androidpublisher_v3 { * The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ givenName?: string; + /** + * Introductory price information of the subscription. This is only present when the subscription was purchased with an introductory price. This field does not indicate the subscription is currently in introductory price period. + */ + introductoryPriceInfo?: Schema$IntroductoryPriceInfo; /** * This kind represents a subscriptionPurchase object in the androidpublisher service. */ @@ -761,7 +790,7 @@ export namespace androidpublisher_v3 { */ priceCurrencyCode?: string; /** - * The profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. + * The Google profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ profileId?: string; /** @@ -800,7 +829,13 @@ export namespace androidpublisher_v3 { newExpiryTimeMillis?: string; } export interface Schema$Testers { + /** + * A list of all Google Groups, as email addresses, that define testers for this track. + */ googleGroups?: string[]; + /** + * A list of all Google+ Communities, as URLs, that define testers for this track. + */ googlePlusCommunities?: string[]; } export interface Schema$Timestamp { diff --git a/src/apis/androidpublisher/webpack.config.js b/src/apis/androidpublisher/webpack.config.js index 20088b2d4f6..e6697e112de 100644 --- a/src/apis/androidpublisher/webpack.config.js +++ b/src/apis/androidpublisher/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/appengine/package.json b/src/apis/appengine/package.json index 785fd967762..5c5a2c16b82 100644 --- a/src/apis/appengine/package.json +++ b/src/apis/appengine/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts index 13b70b4c218..57a0354c198 100644 --- a/src/apis/appengine/v1.ts +++ b/src/apis/appengine/v1.ts @@ -1301,7 +1301,7 @@ export namespace appengine_v1 { uploadPathRegex?: string; } /** - * 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 needsOverviewThe 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 mappingThe 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 usesThe 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. + * 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). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/appengine/v1alpha.ts b/src/apis/appengine/v1alpha.ts index 4d78e75687f..2ace0a57892 100644 --- a/src/apis/appengine/v1alpha.ts +++ b/src/apis/appengine/v1alpha.ts @@ -510,7 +510,7 @@ export namespace appengine_v1alpha { isManagedCertificate?: boolean; } /** - * 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 needsOverviewThe 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 mappingThe 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 usesThe 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. + * 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). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index eae4690bf9b..19f476c899a 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -1361,7 +1361,7 @@ export namespace appengine_v1beta { uploadPathRegex?: string; } /** - * 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 needsOverviewThe 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 mappingThe 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 usesThe 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. + * 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). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/appengine/webpack.config.js b/src/apis/appengine/webpack.config.js index f415acc732d..e36cd4d2ae2 100644 --- a/src/apis/appengine/webpack.config.js +++ b/src/apis/appengine/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/appsactivity/package.json b/src/apis/appsactivity/package.json index a29bc3df7c3..deb743f01a8 100644 --- a/src/apis/appsactivity/package.json +++ b/src/apis/appsactivity/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/appsactivity/webpack.config.js b/src/apis/appsactivity/webpack.config.js index bf4136d8af6..b8d8c97e6dd 100644 --- a/src/apis/appsactivity/webpack.config.js +++ b/src/apis/appsactivity/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/appstate/package.json b/src/apis/appstate/package.json index fc8bfc25c45..58668f660c7 100644 --- a/src/apis/appstate/package.json +++ b/src/apis/appstate/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/appstate/webpack.config.js b/src/apis/appstate/webpack.config.js index edb4e562468..3e56d65c897 100644 --- a/src/apis/appstate/webpack.config.js +++ b/src/apis/appstate/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/bigquery/package.json b/src/apis/bigquery/package.json index 0a0b5d53be3..04d0d926dc0 100644 --- a/src/apis/bigquery/package.json +++ b/src/apis/bigquery/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index 0cc60148c5f..b58e2f44bed 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -93,6 +93,7 @@ export namespace bigquery_v2 { jobs: Resource$Jobs; models: Resource$Models; projects: Resource$Projects; + routines: Resource$Routines; tabledata: Resource$Tabledata; tables: Resource$Tables; @@ -106,13 +107,14 @@ export namespace bigquery_v2 { this.jobs = new Resource$Jobs(this.context); this.models = new Resource$Models(this.context); this.projects = new Resource$Projects(this.context); + this.routines = new Resource$Routines(this.context); this.tabledata = new Resource$Tabledata(this.context); this.tables = new Resource$Tables(this.context); } } /** - * Aggregate metrics for classification models. For multi-class models, the metrics are either macro-averaged: metrics are calculated for each label and then an unweighted average is taken of those values or micro-averaged: the metric is calculated globally by counting the total number of correctly predicted rows. + * Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. */ export interface Schema$AggregateClassificationMetrics { /** @@ -144,6 +146,27 @@ export namespace bigquery_v2 { */ threshold?: number; } + /** + * Input/output argument of a function or a stored procedure. + */ + export interface Schema$Argument { + /** + * Optional. Defaults to FIXED_TYPE. + */ + argumentKind?: string; + /** + * Required unless argument_kind = ANY_TYPE. + */ + dataType?: Schema$StandardSqlDataType; + /** + * Optional. Specifies whether the argument is input or output. Can be set for procedures only. + */ + mode?: string; + /** + * Optional. The name of this argument. Can be absent for function return argument. + */ + name?: string; + } export interface Schema$BigQueryModelTraining { /** * [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress. @@ -214,7 +237,7 @@ export namespace bigquery_v2 { readRowkeyAsString?: boolean; } /** - * Evaluation metrics for binary classification models. + * Evaluation metrics for binary classification/classifier models. */ export interface Schema$BinaryClassificationMetrics { /** @@ -225,11 +248,27 @@ export namespace bigquery_v2 { * Binary confusion matrix at multiple thresholds. */ binaryConfusionMatrixList?: Schema$BinaryConfusionMatrix[]; + /** + * Label representing the negative class. + */ + negativeLabel?: string; + /** + * Label representing the positive class. + */ + positiveLabel?: string; } /** * Confusion matrix for binary classification models. */ export interface Schema$BinaryConfusionMatrix { + /** + * The fraction of predictions given the correct label. + */ + accuracy?: number; + /** + * The equally weighted average of recall and precision. + */ + f1Score?: number; /** * Number of false samples predicted as false. */ @@ -243,11 +282,11 @@ export namespace bigquery_v2 { */ positiveClassThreshold?: number; /** - * Aggregate precision. + * The fraction of actual positive predictions that had positive actual labels. */ precision?: number; /** - * Aggregate recall. + * The fraction of actual positive labels that were given a positive prediction. */ recall?: number; /** @@ -298,7 +337,6 @@ export namespace bigquery_v2 { * [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?: { - minRelProgress?: number; l2Reg?: number; learnRateStrategy?: string; warmStart?: boolean; @@ -307,6 +345,7 @@ export namespace bigquery_v2 { l1Reg?: number; maxIteration?: string; learnRate?: number; + minRelProgress?: number; }; } /** @@ -389,8 +428,8 @@ export namespace bigquery_v2 { * [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; */ access?: Array<{ - domain?: string; userByEmail?: string; + domain?: string; iamMember?: string; specialGroup?: string; role?: string; @@ -405,6 +444,7 @@ export namespace bigquery_v2 { * [Required] A reference that identifies the dataset. */ datasetReference?: Schema$DatasetReference; + defaultEncryptionConfiguration?: Schema$EncryptionConfiguration; /** * [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. */ @@ -455,12 +495,12 @@ export namespace bigquery_v2 { * An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project. */ datasets?: Array<{ - kind?: string; - labels?: {[key: string]: string}; - datasetReference?: Schema$DatasetReference; id?: string; location?: string; friendlyName?: string; + kind?: string; + labels?: {[key: string]: string}; + datasetReference?: Schema$DatasetReference; }>; /** * A hash value of the results page. You can use this property to determine if the page has changed since the last request. @@ -537,11 +577,11 @@ export namespace bigquery_v2 { reason?: string; } /** - * Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. + * Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models. */ export interface Schema$EvaluationMetrics { /** - * Populated for binary classification models. + * Populated for binary classification/classifier models. */ binaryClassificationMetrics?: Schema$BinaryClassificationMetrics; /** @@ -549,7 +589,7 @@ export namespace bigquery_v2 { */ clusteringMetrics?: Schema$ClusteringMetrics; /** - * Populated for multi-class classification models. + * Populated for multi-class classification/classifier models. */ multiClassClassificationMetrics?: Schema$MultiClassClassificationMetrics; /** @@ -707,9 +747,13 @@ export namespace bigquery_v2 { */ googleSheetsOptions?: Schema$GoogleSheetsOptions; /** - * [Optional, Experimental] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error. + * [Optional, Trusted Tester] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error. Note: this setting is in the process of being deprecated in favor of hivePartitioningOptions. */ hivePartitioningMode?: string; + /** + * [Optional, Trusted Tester] Options to configure hive partitioning support. + */ + hivePartitioningOptions?: Schema$HivePartitioningOptions; /** * [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. */ @@ -801,6 +845,16 @@ export namespace bigquery_v2 { */ skipLeadingRows?: string; } + export interface Schema$HivePartitioningOptions { + /** + * [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet. + */ + mode?: string; + /** + * [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter). + */ + sourceUriPrefix?: string; + } /** * Information about a single iteration of the training run. */ @@ -984,9 +1038,13 @@ export namespace bigquery_v2 { */ fieldDelimiter?: string; /** - * [Optional, Experimental] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error. + * [Optional, Trusted Tester] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error. */ hivePartitioningMode?: string; + /** + * [Optional, Trusted Tester] Options to configure hive partitioning support. + */ + hivePartitioningOptions?: Schema$HivePartitioningOptions; /** * [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names */ @@ -1177,15 +1235,15 @@ export namespace bigquery_v2 { * List of jobs that were requested. */ jobs?: Array<{ + id?: string; + configuration?: Schema$JobConfiguration; user_email?: string; - errorResult?: Schema$ErrorProto; kind?: string; + errorResult?: Schema$ErrorProto; jobReference?: Schema$JobReference; status?: Schema$JobStatus; state?: string; statistics?: Schema$JobStatistics; - id?: string; - configuration?: Schema$JobConfiguration; }>; /** * The resource type of the response. @@ -1250,7 +1308,11 @@ export namespace bigquery_v2 { /** * [Output-only] Job resource usage breakdown by reservation. */ - reservationUsage?: Array<{slotMs?: string; name?: string}>; + reservationUsage?: Array<{name?: string; slotMs?: string}>; + /** + * [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job. + */ + reservation_id?: string; /** * [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE. */ @@ -1415,6 +1477,16 @@ export namespace bigquery_v2 { */ nextPageToken?: string; } + export interface Schema$ListRoutinesResponse { + /** + * A token to request the next page of results. + */ + nextPageToken?: string; + /** + * Routines in the requested dataset. Only the following fields are populated: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, language. + */ + routines?: Schema$Routine[]; + } /** * BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses. */ @@ -1440,7 +1512,7 @@ export namespace bigquery_v2 { */ creationTime?: string; /** - * [Optional] A user-friendly description of this model. @mutable bigquery.models.patch + * [Optional] A user-friendly description of this model. */ description?: string; /** @@ -1448,7 +1520,7 @@ export namespace bigquery_v2 { */ etag?: string; /** - * [Optional] The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models. @mutable bigquery.models.patch + * [Optional] The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models. */ expirationTime?: string; /** @@ -1456,15 +1528,15 @@ export namespace bigquery_v2 { */ featureColumns?: Schema$StandardSqlField[]; /** - * [Optional] A descriptive name for this model. @mutable bigquery.models.patch + * [Optional] A descriptive name for this model. */ friendlyName?: string; /** - * Output only. Label columns that were used to train this model. The output of the model will have a “predicted_” prefix to these columns. + * Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns. */ labelColumns?: Schema$StandardSqlField[]; /** - * [Optional] The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. @mutable bigquery.models.patch + * [Optional] The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. */ labels?: {[key: string]: string}; /** @@ -1492,7 +1564,7 @@ export namespace bigquery_v2 { /** * [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?: {lossType?: string; modelType?: string; labels?: string[]}; + modelOptions?: {labels?: string[]; lossType?: string; modelType?: string}; /** * [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. */ @@ -1516,7 +1588,7 @@ export namespace bigquery_v2 { projectId?: string; } /** - * Evaluation metrics for multi-class classification models. + * Evaluation metrics for multi-class classification/classifier models. */ export interface Schema$MultiClassClassificationMetrics { /** @@ -1545,11 +1617,11 @@ export namespace bigquery_v2 { * Projects to which you have at least READ access. */ projects?: Array<{ - id?: string; - projectReference?: Schema$ProjectReference; friendlyName?: string; numericId?: string; kind?: string; + id?: string; + projectReference?: Schema$ProjectReference; }>; /** * The total number of projects in the list. @@ -1734,7 +1806,7 @@ export namespace bigquery_v2 { /** * [TrustedTester] [Required] Defines the ranges for range partitioning. */ - range?: {interval?: string; start?: string; end?: string}; + range?: {end?: string; interval?: string; start?: string}; } /** * Evaluation metrics for regression models. @@ -1761,6 +1833,51 @@ export namespace bigquery_v2 { */ rSquared?: number; } + /** + * A user-defined function or a stored procedure. + */ + export interface Schema$Routine { + /** + * Optional. + */ + arguments?: Schema$Argument[]; + /** + * Output only. The time when this routine was created, in milliseconds since the epoch. + */ + creationTime?: string; + /** + * Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "x/", y))` The definition_body is `concat(x, "x/", y)` (x/ is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "x/";x/'` The definition_body is `return "x/";x/` Note that both x/ are replaced with linebreaks. + */ + definitionBody?: string; + /** + * Output only. A hash of this resource. + */ + etag?: string; + /** + * Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. + */ + importedLibraries?: string[]; + /** + * Optional. Defaults to "SQL". + */ + language?: string; + /** + * Output only. The time when this routine was last modified, in milliseconds since the epoch. + */ + lastModifiedTime?: string; + /** + * Optional if language = "SQL"; required otherwise. If absent, the return type is inferred from definition_body at query time in each query that references this routine. If present, then the evaluated result will be cast to the specified returned type at query time. For example, for the functions created with the following statements: * `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);` * `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));` * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));` The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and is absent for `Increment` (inferred as FLOAT64 at query time). Suppose the function `Add` is replaced by `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);` Then the inferred return type of `Increment` is automatically changed to INT64 at query time, while the return type of `Decrement` remains FLOAT64. + */ + returnType?: Schema$StandardSqlDataType; + /** + * Required. Reference describing the ID of this routine. + */ + routineReference?: Schema$RoutineReference; + /** + * Required. + */ + routineType?: string; + } export interface Schema$RoutineReference { /** * [Required] The ID of the dataset containing this routine. @@ -2054,8 +2171,8 @@ export namespace bigquery_v2 { id?: string; expirationTime?: string; tableReference?: Schema$TableReference; - timePartitioning?: Schema$TimePartitioning; friendlyName?: string; + timePartitioning?: Schema$TimePartitioning; kind?: string; view?: {useLegacySql?: boolean}; creationTime?: string; @@ -2125,11 +2242,11 @@ export namespace bigquery_v2 { */ distanceType?: string; /** - * Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). + * Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms. */ earlyStop?: boolean; /** - * Specifies the initial learning rate for line search to start at. + * Specifies the initial learning rate for the line search learn rate strategy. */ initialLearnRate?: number; /** @@ -2145,15 +2262,15 @@ export namespace bigquery_v2 { */ l2Regularization?: number; /** - * Weights associated with each label class, for rebalancing the training data. + * Weights associated with each label class, for rebalancing the training data. Only applicable for classification models. */ labelClassWeights?: {[key: string]: number}; /** - * Learning rate in training. + * Learning rate in training. Used only for iterative training algorithms. */ learnRate?: number; /** - * The strategy to determine learning rate. + * The strategy to determine learn rate for the current iteration. */ learnRateStrategy?: string; /** @@ -2161,17 +2278,25 @@ export namespace bigquery_v2 { */ lossType?: string; /** - * The maximum number of iterations in training. + * The maximum number of iterations in training. Used only for iterative training algorithms. */ maxIterations?: string; /** - * When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. + * When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. */ minRelativeProgress?: number; + /** + * [Beta] Google Cloud Storage URI from which the model was imported. Only applicable for imported models. + */ + modelUri?: string; /** * [Beta] Number of clusters for clustering models. */ numClusters?: string; + /** + * Optimization strategy for training linear regression models. + */ + optimizationStrategy?: string; /** * Whether to train a model from the last checkpoint. */ @@ -2270,16 +2395,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.datasets.delete @@ -2328,7 +2449,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2395,16 +2516,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.datasets.get @@ -2452,7 +2569,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2520,16 +2637,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.datasets.insert @@ -2577,7 +2690,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2654,16 +2767,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.datasets.list @@ -2716,7 +2825,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2788,16 +2897,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.datasets.patch @@ -2846,7 +2951,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2918,16 +3023,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.datasets.update @@ -2976,7 +3077,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3168,16 +3269,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.jobs.cancel @@ -3228,7 +3325,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3295,16 +3392,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.jobs.get @@ -3353,7 +3446,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3433,16 +3526,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.jobs.getQueryResults @@ -3502,7 +3591,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3577,16 +3666,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.jobs.insert @@ -3637,7 +3722,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3718,16 +3803,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.jobs.list @@ -3781,7 +3862,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3850,16 +3931,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.jobs.query @@ -3909,7 +3986,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -4103,6 +4180,55 @@ export namespace bigquery_v2 { /** * bigquery.models.delete * @desc Deletes the model specified by modelId from the dataset. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the BigQuery API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/bigquery + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var bigquery = google.bigquery('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID of the model to delete. + * projectId: 'my-project-id', // TODO: Update placeholder value. + * + * // Dataset ID of the model to delete. + * datasetId: 'my-dataset-id', // TODO: Update placeholder value. + * + * // Model ID of the model to delete. + * modelId: 'my-model-id', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * bigquery.models.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias bigquery.models.delete * @memberOf! () * @@ -4149,7 +4275,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -4176,6 +4302,58 @@ export namespace bigquery_v2 { /** * bigquery.models.get * @desc Gets the specified model resource by model ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the BigQuery API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/bigquery + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var bigquery = google.bigquery('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID of the requested model. + * projectId: 'my-project-id', // TODO: Update placeholder value. + * + * // Dataset ID of the requested model. + * datasetId: 'my-dataset-id', // TODO: Update placeholder value. + * + * // Model ID of the requested model. + * modelId: 'my-model-id', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * bigquery.models.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias bigquery.models.get * @memberOf! () * @@ -4222,7 +4400,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -4249,27 +4427,89 @@ export namespace bigquery_v2 { /** * bigquery.models.list * @desc Lists all models in the specified dataset. Requires the READER dataset role. - * @alias bigquery.models.list - * @memberOf! () + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the BigQuery API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/bigquery + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` * - * @param {object} params Parameters for request - * @param {string} params.datasetId Dataset ID of the models to list. - * @param {integer=} params.maxResults The maximum number of results per page. - * @param {string=} params.pageToken Page token, returned by a previous call to request the next page of results - * @param {string} params.projectId Project ID of the models to list. - * @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$Models$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Models$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; + * const {google} = require('googleapis'); + * var bigquery = google.bigquery('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID of the models to list. + * projectId: 'my-project-id', // TODO: Update placeholder value. + * + * // Dataset ID of the models to list. + * datasetId: 'my-dataset-id', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var modelsPage = response['models']; + * if (!modelsPage) { + * return; + * } + * for (var i = 0; i < modelsPage.length; i++) { + * // TODO: Change code below to process each resource in `modelsPage`: + * console.log(JSON.stringify(modelsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * bigquery.models.list(request, handlePage); + * } + * }; + * + * bigquery.models.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias bigquery.models.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.datasetId Dataset ID of the models to list. + * @param {integer=} params.maxResults The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection. + * @param {string=} params.pageToken Page token, returned by a previous call to request the next page of results + * @param {string} params.projectId Project ID of the models to list. + * @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$Models$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Models$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; list( params: Params$Resource$Models$List, callback: BodyResponseCallback @@ -4298,7 +4538,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -4325,6 +4565,63 @@ export namespace bigquery_v2 { /** * bigquery.models.patch * @desc Patch specific fields in the specified model. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the BigQuery API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/bigquery + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var bigquery = google.bigquery('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID of the model to patch. + * projectId: 'my-project-id', // TODO: Update placeholder value. + * + * // Dataset ID of the model to patch. + * datasetId: 'my-dataset-id', // TODO: Update placeholder value. + * + * // Model ID of the model to patch. + * modelId: 'my-model-id', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * bigquery.models.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias bigquery.models.patch * @memberOf! () * @@ -4372,7 +4669,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -4446,7 +4743,7 @@ export namespace bigquery_v2 { */ datasetId?: string; /** - * The maximum number of results per page. + * The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection. */ maxResults?: number; /** @@ -4490,8 +4787,673 @@ export namespace bigquery_v2 { } /** - * bigquery.projects.getServiceAccount - * @desc Returns the email address of the service account for your project used for interactions with Google Cloud KMS. + * bigquery.projects.getServiceAccount + * @desc Returns the email address of the service account for your project used for interactions with Google Cloud KMS. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the BigQuery API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/bigquery + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var bigquery = google.bigquery('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for which the service account is requested. + * projectId: 'my-project-id', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * bigquery.projects.getServiceAccount(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias bigquery.projects.getServiceAccount + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.projectId Project ID for which the service account is requested. + * @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 + */ + getServiceAccount( + params?: Params$Resource$Projects$Getserviceaccount, + options?: MethodOptions + ): GaxiosPromise; + getServiceAccount( + params: Params$Resource$Projects$Getserviceaccount, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getServiceAccount( + params: Params$Resource$Projects$Getserviceaccount, + callback: BodyResponseCallback + ): void; + getServiceAccount( + callback: BodyResponseCallback + ): void; + getServiceAccount( + paramsOrCallback?: + | Params$Resource$Projects$Getserviceaccount + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Getserviceaccount; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Getserviceaccount; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/bigquery/v2/projects/{projectId}/serviceAccount' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['projectId'], + pathParams: ['projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigquery.projects.list + * @desc Lists all projects to which you have been granted any project role. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the BigQuery API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/bigquery + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var bigquery = google.bigquery('v2'); + * + * authorize(function(authClient) { + * var request = { + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var projectsPage = response['projects']; + * if (!projectsPage) { + * return; + * } + * for (var i = 0; i < projectsPage.length; i++) { + * // TODO: Change code below to process each resource in `projectsPage`: + * console.log(JSON.stringify(projectsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * bigquery.projects.list(request, handlePage); + * } + * }; + * + * bigquery.projects.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias bigquery.projects.list + * @memberOf! () + * + * @param {object=} params Parameters for request + * @param {integer=} params.maxResults Maximum number of results to return + * @param {string=} params.pageToken Page token, returned by a previous call, to request the next page of results + * @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$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Projects$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/bigquery/v2/projects').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Getserviceaccount + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for which the service account is requested. + */ + projectId?: string; + } + export interface Params$Resource$Projects$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Maximum number of results to return + */ + maxResults?: number; + /** + * Page token, returned by a previous call, to request the next page of results + */ + pageToken?: string; + } + + export class Resource$Routines { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * bigquery.routines.delete + * @desc Deletes the routine specified by routineId from the dataset. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the BigQuery API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/bigquery + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var bigquery = google.bigquery('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID of the routine to delete + * projectId: 'my-project-id', // TODO: Update placeholder value. + * + * // Dataset ID of the routine to delete + * datasetId: 'my-dataset-id', // TODO: Update placeholder value. + * + * // Routine ID of the routine to delete + * routineId: 'my-routine-id', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * bigquery.routines.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias bigquery.routines.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.datasetId Dataset ID of the routine to delete + * @param {string} params.projectId Project ID of the routine to delete + * @param {string} params.routineId Routine ID of the routine 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$Routines$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Routines$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Routines$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Routines$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Routines$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routines$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/routines/{+routineId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['projectId', 'datasetId', 'routineId'], + pathParams: ['datasetId', 'projectId', 'routineId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigquery.routines.get + * @desc Gets the specified routine resource by routine ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the BigQuery API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/bigquery + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var bigquery = google.bigquery('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID of the requested routine + * projectId: 'my-project-id', // TODO: Update placeholder value. + * + * // Dataset ID of the requested routine + * datasetId: 'my-dataset-id', // TODO: Update placeholder value. + * + * // Routine ID of the requested routine + * routineId: 'my-routine-id', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * bigquery.routines.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias bigquery.routines.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.datasetId Dataset ID of the requested routine + * @param {string=} params.fieldMask If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned. + * @param {string} params.projectId Project ID of the requested routine + * @param {string} params.routineId Routine ID of the requested routine + * @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$Routines$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Routines$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Routines$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Routines$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Routines$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routines$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/routines/{+routineId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['projectId', 'datasetId', 'routineId'], + pathParams: ['datasetId', 'projectId', 'routineId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigquery.routines.insert + * @desc Creates a new routine in the dataset. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the BigQuery API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/bigquery + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var bigquery = google.bigquery('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID of the new routine + * projectId: 'my-project-id', // TODO: Update placeholder value. + * + * // Dataset ID of the new routine + * datasetId: 'my-dataset-id', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * bigquery.routines.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias bigquery.routines.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.datasetId Dataset ID of the new routine + * @param {string} params.projectId Project ID of the new routine + * @param {().Routine} 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$Routines$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Routines$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Routines$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Routines$Insert + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Routines$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routines$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/routines' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['projectId', 'datasetId'], + pathParams: ['datasetId', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigquery.routines.list + * @desc Lists all routines in the specified dataset. Requires the READER dataset role. * @example * * // BEFORE RUNNING: * // --------------- @@ -4512,79 +5474,91 @@ export namespace bigquery_v2 { * * authorize(function(authClient) { * var request = { - * // Project ID for which the service account is requested. + * // Project ID of the routines to list * projectId: 'my-project-id', // TODO: Update placeholder value. * + * // Dataset ID of the routines to list + * datasetId: 'my-dataset-id', // TODO: Update placeholder value. + * * auth: authClient, * }; * - * bigquery.projects.getServiceAccount(request, function(err, response) { + * var handlePage = function(err, response) { * if (err) { * console.error(err); * return; * } * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); + * var routinesPage = response['routines']; + * if (!routinesPage) { * return; * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); + * for (var i = 0; i < routinesPage.length; i++) { + * // TODO: Change code below to process each resource in `routinesPage`: + * console.log(JSON.stringify(routinesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * bigquery.routines.list(request, handlePage); * } - * callback(authClient); + * }; + * + * bigquery.routines.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } - * @alias bigquery.projects.getServiceAccount + * @alias bigquery.routines.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId Project ID for which the service account is requested. + * @param {string} params.datasetId Dataset ID of the routines to list + * @param {integer=} params.maxResults The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection. + * @param {string=} params.pageToken Page token, returned by a previous call, to request the next page of results + * @param {string} params.projectId Project ID of the routines to list * @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 */ - getServiceAccount( - params?: Params$Resource$Projects$Getserviceaccount, + list( + params?: Params$Resource$Routines$List, options?: MethodOptions - ): GaxiosPromise; - getServiceAccount( - params: Params$Resource$Projects$Getserviceaccount, + ): GaxiosPromise; + list( + params: Params$Resource$Routines$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getServiceAccount( - params: Params$Resource$Projects$Getserviceaccount, - callback: BodyResponseCallback - ): void; - getServiceAccount( - callback: BodyResponseCallback + list( + params: Params$Resource$Routines$List, + callback: BodyResponseCallback ): void; - getServiceAccount( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Getserviceaccount - | BodyResponseCallback, + | Params$Resource$Routines$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Getserviceaccount; + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Routines$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Getserviceaccount; + params = {} as Params$Resource$Routines$List; options = {}; } @@ -4593,35 +5567,33 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { url: ( - rootUrl + '/bigquery/v2/projects/{projectId}/serviceAccount' + rootUrl + + '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/routines' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['projectId'], - pathParams: ['projectId'], + requiredParams: ['projectId', 'datasetId'], + pathParams: ['datasetId', 'projectId'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * bigquery.projects.list - * @desc Lists all projects to which you have been granted any project role. + * bigquery.routines.update + * @desc Updates information in an existing routine. The update method replaces the entire Routine resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -4642,85 +5614,82 @@ export namespace bigquery_v2 { * * authorize(function(authClient) { * var request = { + * // Project ID of the routine to update + * projectId: 'my-project-id', // TODO: Update placeholder value. + * + * // Dataset ID of the routine to update + * datasetId: 'my-dataset-id', // TODO: Update placeholder value. + * + * // Routine ID of the routine to update + * routineId: 'my-routine-id', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * * auth: authClient, * }; * - * var handlePage = function(err, response) { + * bigquery.routines.update(request, function(err, response) { * if (err) { * console.error(err); * return; * } * - * var projectsPage = response['projects']; - * if (!projectsPage) { - * return; - * } - * for (var i = 0; i < projectsPage.length; i++) { - * // TODO: Change code below to process each resource in `projectsPage`: - * console.log(JSON.stringify(projectsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * bigquery.projects.list(request, handlePage); - * } - * }; - * - * bigquery.projects.list(request, handlePage); + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } - * @alias bigquery.projects.list + * @alias bigquery.routines.update * @memberOf! () * - * @param {object=} params Parameters for request - * @param {integer=} params.maxResults Maximum number of results to return - * @param {string=} params.pageToken Page token, returned by a previous call, to request the next page of results + * @param {object} params Parameters for request + * @param {string} params.datasetId Dataset ID of the routine to update + * @param {string} params.projectId Project ID of the routine to update + * @param {string} params.routineId Routine ID of the routine to update + * @param {().Routine} 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 */ - list( - params?: Params$Resource$Projects$List, + update( + params?: Params$Resource$Routines$Update, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + update( + params: Params$Resource$Routines$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$List, - callback: BodyResponseCallback + update( + params: Params$Resource$Routines$Update, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Projects$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Projects$List; + | Params$Resource$Routines$Update + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Routines$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$List; + params = {} as Params$Resource$Routines$Update; options = {}; } @@ -4729,57 +5698,139 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/bigquery/v2/projects').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + + '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/routines/{+routineId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['projectId', 'datasetId', 'routineId'], + pathParams: ['datasetId', 'projectId', 'routineId'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Getserviceaccount - extends StandardParameters { + export interface Params$Resource$Routines$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Project ID for which the service account is requested. + * Dataset ID of the routine to delete + */ + datasetId?: string; + /** + * Project ID of the routine to delete */ projectId?: string; + /** + * Routine ID of the routine to delete + */ + routineId?: string; } - export interface Params$Resource$Projects$List extends StandardParameters { + export interface Params$Resource$Routines$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Maximum number of results to return + * Dataset ID of the requested routine + */ + datasetId?: string; + /** + * If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned. + */ + fieldMask?: string; + /** + * Project ID of the requested routine + */ + projectId?: string; + /** + * Routine ID of the requested routine + */ + routineId?: string; + } + export interface Params$Resource$Routines$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Dataset ID of the new routine + */ + datasetId?: string; + /** + * Project ID of the new routine + */ + projectId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Routine; + } + export interface Params$Resource$Routines$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Dataset ID of the routines to list + */ + datasetId?: string; + /** + * The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection. */ maxResults?: number; /** * Page token, returned by a previous call, to request the next page of results */ pageToken?: string; + /** + * Project ID of the routines to list + */ + projectId?: string; + } + export interface Params$Resource$Routines$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Dataset ID of the routine to update + */ + datasetId?: string; + /** + * Project ID of the routine to update + */ + projectId?: string; + /** + * Routine ID of the routine to update + */ + routineId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Routine; } export class Resource$Tabledata { @@ -4839,16 +5890,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.tabledata.insertAll @@ -4905,7 +5952,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -4992,16 +6039,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.tabledata.list @@ -5056,7 +6099,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -5192,16 +6235,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.tables.delete @@ -5250,7 +6289,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -5321,16 +6360,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.tables.get @@ -5380,7 +6415,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -5452,16 +6487,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.tables.insert @@ -5510,7 +6541,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -5591,16 +6622,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.tables.list @@ -5652,7 +6679,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -5728,16 +6755,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.tables.patch @@ -5787,7 +6810,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { @@ -5863,16 +6886,12 @@ export namespace bigquery_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias bigquery.tables.update @@ -5922,7 +6941,7 @@ export namespace bigquery_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://bigquery.googleapis.com/'; const parameters = { options: Object.assign( { diff --git a/src/apis/bigquery/webpack.config.js b/src/apis/bigquery/webpack.config.js index b44349ff122..80233e75744 100644 --- a/src/apis/bigquery/webpack.config.js +++ b/src/apis/bigquery/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/bigquerydatatransfer/package.json b/src/apis/bigquerydatatransfer/package.json index 5cf66c2fa89..89af1664746 100644 --- a/src/apis/bigquerydatatransfer/package.json +++ b/src/apis/bigquerydatatransfer/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index b634d282881..48100c413a3 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -215,6 +215,10 @@ export namespace bigquerydatatransfer_v1 { * All possible values for the parameter. */ allowedValues?: string[]; + /** + * If true, it should not be used in new transfers, and it should not be visible to users. + */ + deprecated?: boolean; /** * Parameter description. */ @@ -428,7 +432,7 @@ export namespace bigquerydatatransfer_v1 { runs?: Schema$TransferRun[]; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -564,7 +568,7 @@ export namespace bigquerydatatransfer_v1 { */ params?: {[key: string]: any}; /** - * For batch transfer runs, specifies the date and time that data should be ingested. + * For batch transfer runs, specifies the date and time of the data should be ingested. */ runTime?: string; /** @@ -1405,7 +1409,7 @@ export namespace bigquerydatatransfer_v1 { * @param {object} params Parameters for request * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. * @param {string} params.parent The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. - * @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. + * @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. * @param {().TransferConfig} 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. @@ -1711,7 +1715,7 @@ export namespace bigquerydatatransfer_v1 { * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. * @param {string} params.name The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id. * @param {string=} params.updateMask Required list of fields to be updated in this request. - * @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. + * @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. * @param {().TransferConfig} 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. @@ -1964,7 +1968,7 @@ export namespace bigquerydatatransfer_v1 { */ parent?: string; /** - * Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. + * Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. */ versionInfo?: string; @@ -2041,7 +2045,7 @@ export namespace bigquerydatatransfer_v1 { */ updateMask?: string; /** - * Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. + * Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. */ versionInfo?: string; @@ -2498,7 +2502,7 @@ export namespace bigquerydatatransfer_v1 { * @param {object} params Parameters for request * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. * @param {string} params.parent The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. - * @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. + * @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. * @param {().TransferConfig} 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. @@ -2804,7 +2808,7 @@ export namespace bigquerydatatransfer_v1 { * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. * @param {string} params.name The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id. * @param {string=} params.updateMask Required list of fields to be updated in this request. - * @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. + * @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. * @param {().TransferConfig} 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. @@ -3057,7 +3061,7 @@ export namespace bigquerydatatransfer_v1 { */ parent?: string; /** - * Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. + * Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. */ versionInfo?: string; @@ -3134,7 +3138,7 @@ export namespace bigquerydatatransfer_v1 { */ updateMask?: string; /** - * Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the “none+gsession” response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. + * Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. */ versionInfo?: string; diff --git a/src/apis/bigquerydatatransfer/webpack.config.js b/src/apis/bigquerydatatransfer/webpack.config.js index f92e684db39..9294c259c41 100644 --- a/src/apis/bigquerydatatransfer/webpack.config.js +++ b/src/apis/bigquerydatatransfer/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/bigtableadmin/package.json b/src/apis/bigtableadmin/package.json index 8132a2f49bb..cb39b33b25a 100644 --- a/src/apis/bigtableadmin/package.json +++ b/src/apis/bigtableadmin/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/bigtableadmin/v1.ts b/src/apis/bigtableadmin/v1.ts index 265b42f7a3c..e57a7ff4486 100644 --- a/src/apis/bigtableadmin/v1.ts +++ b/src/apis/bigtableadmin/v1.ts @@ -105,15 +105,12 @@ export namespace bigtableadmin_v1 { */ export class Bigtableadmin { context: APIRequestContext; - projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { _options: options || {}, google, }; - - this.projects = new Resource$Projects(this.context); } } @@ -243,44 +240,6 @@ export namespace bigtableadmin_v1 { */ type?: 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?: {[key: string]: string}; - /** - * 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?: {[key: string]: any}; - /** - * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` - */ - name?: string; - } /** * Request message for BigtableInstanceAdmin.PartialUpdateInstance. */ @@ -346,207 +305,4 @@ export namespace bigtableadmin_v1 { */ requestTime?: string; } - - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - } - } - - export class Resource$Projects$Locations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * bigtableadmin.projects.locations.get - * @desc Gets information about a location. - * @alias bigtableadmin.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 - ): GaxiosPromise; - 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 | GaxiosPromise { - 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://bigtableadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * bigtableadmin.projects.locations.list - * @desc Lists information about the supported locations for this service. - * @alias bigtableadmin.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 - ): GaxiosPromise; - 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 | GaxiosPromise { - 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://bigtableadmin.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.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Get - extends StandardParameters { - /** - * 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 - extends StandardParameters { - /** - * 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/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index d4827fb1fc8..84efaf124f3 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -132,7 +132,7 @@ export namespace bigtableadmin_v2 { */ etag?: string; /** - * Use a multi-cluster routing policy that may pick any cluster. + * Use a multi-cluster routing policy. */ multiClusterRoutingUseAny?: Schema$MultiClusterRoutingUseAny; /** @@ -337,7 +337,7 @@ export namespace bigtableadmin_v2 { */ table?: Schema$Table; /** - * The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `<parent>/tables/foobar`. + * The name by which the new table should be referred to within the parent instance, e.g., `foobar` rather than `<parent>/tables/foobar`. Maximum 50 characters. */ tableId?: string; } @@ -502,6 +502,19 @@ export namespace bigtableadmin_v2 { */ nextPageToken?: 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; + } /** * The response message for Operations.ListOperations. */ @@ -528,6 +541,31 @@ export namespace bigtableadmin_v2 { */ tables?: Schema$Table[]; } + /** + * 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?: {[key: string]: string}; + /** + * 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?: {[key: string]: any}; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string; + } /** * A create, update, or delete of a particular column family. */ @@ -559,7 +597,7 @@ export namespace bigtableadmin_v2 { modifications?: Schema$Modification[]; } /** - * Read/write requests may be routed to any cluster in the instance, and will fail over to another cluster in the event of transient errors or delays. Choosing this option sacrifices read-your-writes consistency to improve availability. + * Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability. */ export interface Schema$MultiClusterRoutingUseAny {} /** @@ -579,7 +617,7 @@ export namespace bigtableadmin_v2 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -635,7 +673,7 @@ export namespace bigtableadmin_v2 { updateMask?: string; } /** - * Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency, but does not improve availability. + * Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability. */ export interface Schema$SingleClusterRouting { /** @@ -657,7 +695,7 @@ export namespace bigtableadmin_v2 { key?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -1156,9 +1194,11 @@ export namespace bigtableadmin_v2 { export class Resource$Projects { context: APIRequestContext; instances: Resource$Projects$Instances; + locations: Resource$Projects$Locations; constructor(context: APIRequestContext) { this.context = context; this.instances = new Resource$Projects$Instances(this.context); + this.locations = new Resource$Projects$Locations(this.context); } } @@ -2230,7 +2270,7 @@ export namespace bigtableadmin_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize Maximum number of results per page. CURRENTLY UNIMPLEMENTED AND IGNORED. + * @param {integer=} params.pageSize Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request. * @param {string=} params.pageToken The value of `next_page_token` returned by a previous call. * @param {string} params.parent The unique name of the instance for which a list of app profiles is requested. Values are of the form `projects//instances/`. Use ` = '-'` to list AppProfiles for all Instances in a project, e.g., `projects/myproject/instances/-`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2439,7 +2479,7 @@ export namespace bigtableadmin_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Maximum number of results per page. CURRENTLY UNIMPLEMENTED AND IGNORED. + * Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request. */ pageSize?: number; /** @@ -3391,80 +3431,6 @@ export namespace bigtableadmin_v2 { } } - /** - * bigtableadmin.projects.instances.tables.getIamPolicy - * @desc Gets the access control policy for an instance resource. Returns an empty policy if an table exists but does not have a policy set. - * @alias bigtableadmin.projects.instances.tables.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$Instances$Tables$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Instances$Tables$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Instances$Tables$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Instances$Tables$Getiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Instances$Tables$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Instances$Tables$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://bigtableadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * bigtableadmin.projects.instances.tables.list * @desc Lists all tables served from a specified instance. @@ -3616,163 +3582,6 @@ export namespace bigtableadmin_v2 { return createAPIRequest(parameters); } } - - /** - * bigtableadmin.projects.instances.tables.setIamPolicy - * @desc Sets the access control policy on a table resource. Replaces any existing policy. - * @alias bigtableadmin.projects.instances.tables.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$Instances$Tables$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Instances$Tables$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Instances$Tables$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Instances$Tables$Setiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Instances$Tables$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Instances$Tables$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://bigtableadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * bigtableadmin.projects.instances.tables.testIamPermissions - * @desc Returns permissions that the caller has on the specified table resource. - * @alias bigtableadmin.projects.instances.tables.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$Instances$Tables$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Instances$Tables$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Instances$Tables$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Instances$Tables$Testiampermissions - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Instances$Tables$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Instances$Tables$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://bigtableadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } } export interface Params$Resource$Projects$Instances$Tables$Checkconsistency @@ -3871,23 +3680,6 @@ export namespace bigtableadmin_v2 { */ view?: string; } - export interface Params$Resource$Projects$Instances$Tables$Getiampolicy - extends StandardParameters { - /** - * 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$Instances$Tables$List extends StandardParameters { /** @@ -3929,24 +3721,177 @@ export namespace bigtableadmin_v2 { */ requestBody?: Schema$ModifyColumnFamiliesRequest; } - export interface Params$Resource$Projects$Instances$Tables$Setiampolicy - extends StandardParameters { + + export class Resource$Projects$Locations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + /** - * Auth client or API Key for the request + * bigtableadmin.projects.locations.get + * @desc Gets information about a location. + * @alias bigtableadmin.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 */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } /** - * REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * bigtableadmin.projects.locations.list + * @desc Lists information about the supported locations for this service. + * @alias bigtableadmin.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 */ - resource?: string; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { /** - * Request body metadata + * Auth client or API Key for the request */ - requestBody?: Schema$SetIamPolicyRequest; + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Resource name for the location. + */ + name?: string; } - export interface Params$Resource$Projects$Instances$Tables$Testiampermissions + export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** * Auth client or API Key for the request @@ -3954,13 +3899,20 @@ export namespace bigtableadmin_v2 { 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. + * The standard list filter. */ - resource?: string; - + filter?: string; /** - * Request body metadata + * The resource that owns the locations collection, if applicable. */ - requestBody?: Schema$TestIamPermissionsRequest; + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; } } diff --git a/src/apis/bigtableadmin/webpack.config.js b/src/apis/bigtableadmin/webpack.config.js index f0d62551d15..82876e4010e 100644 --- a/src/apis/bigtableadmin/webpack.config.js +++ b/src/apis/bigtableadmin/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/binaryauthorization/package.json b/src/apis/binaryauthorization/package.json index d8a1a156560..c095f76ee70 100644 --- a/src/apis/binaryauthorization/package.json +++ b/src/apis/binaryauthorization/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/binaryauthorization/v1beta1.ts b/src/apis/binaryauthorization/v1beta1.ts index c505115100f..5b2e4b7278a 100644 --- a/src/apis/binaryauthorization/v1beta1.ts +++ b/src/apis/binaryauthorization/v1beta1.ts @@ -360,7 +360,7 @@ export namespace binaryauthorization_v1beta1 { /** * binaryauthorization.projects.getPolicy - * @desc Gets the policy for this project. Returns a default policy if the project does not have one. + * @desc A policy specifies the attestors that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy. Gets the policy for this project. Returns a default policy if the project does not have one. * @alias binaryauthorization.projects.getPolicy * @memberOf! () * @@ -758,6 +758,7 @@ export namespace binaryauthorization_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1188,6 +1189,10 @@ export namespace binaryauthorization_v1beta1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ @@ -1278,6 +1283,7 @@ export namespace binaryauthorization_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1513,6 +1519,10 @@ export namespace binaryauthorization_v1beta1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ diff --git a/src/apis/binaryauthorization/webpack.config.js b/src/apis/binaryauthorization/webpack.config.js index d93a16f4774..68fdb2dd110 100644 --- a/src/apis/binaryauthorization/webpack.config.js +++ b/src/apis/binaryauthorization/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/blogger/package.json b/src/apis/blogger/package.json index 0e19ba659bc..704c9f83db0 100644 --- a/src/apis/blogger/package.json +++ b/src/apis/blogger/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/blogger/webpack.config.js b/src/apis/blogger/webpack.config.js index 15e0267f4ac..28f1e92b2e9 100644 --- a/src/apis/blogger/webpack.config.js +++ b/src/apis/blogger/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/books/package.json b/src/apis/books/package.json index 09aa43699ae..485b8dc0144 100644 --- a/src/apis/books/package.json +++ b/src/apis/books/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/books/webpack.config.js b/src/apis/books/webpack.config.js index faa38d48987..46e7e51591c 100644 --- a/src/apis/books/webpack.config.js +++ b/src/apis/books/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/calendar/package.json b/src/apis/calendar/package.json index 4a7f7d4d977..b8f833f5d59 100644 --- a/src/apis/calendar/package.json +++ b/src/apis/calendar/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/calendar/v3.ts b/src/apis/calendar/v3.ts index c6191c4a007..cf65d1e9432 100644 --- a/src/apis/calendar/v3.ts +++ b/src/apis/calendar/v3.ts @@ -317,7 +317,7 @@ export namespace calendar_v3 { */ id?: string; /** - * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". + * Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". */ kind?: string; /** diff --git a/src/apis/calendar/webpack.config.js b/src/apis/calendar/webpack.config.js index fa32f84af92..945274cd515 100644 --- a/src/apis/calendar/webpack.config.js +++ b/src/apis/calendar/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/chat/README.md b/src/apis/chat/README.md index 738a51e07c2..bcd29e805c1 100644 --- a/src/apis/chat/README.md +++ b/src/apis/chat/README.md @@ -33,27 +33,6 @@ const { chat, auth } = Chat; ``` -## Using the client library - -```js -// Assuming that `GOOGLE_APPLICATION_CREDENTIALS="/app/.data/chatbot.json"` is set as an environment variable with the path to the json key that you downloaded when creating a service account for your bot. - -const {google} = require("googleapis") -const SCOPES = ["https://www.googleapis.com/auth/chat.bot"] - -async main() { - const auth = await google.auth.getClient({ - scopes: SCOPES - }) - const chat = google.chat({version: "v1", auth: auth}) - console.log(chat) - const project = await google.auth.getProjectId() - const spaces = await chat.spaces.list() -} - -main() -``` - ## License This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/master/LICENSE). diff --git a/src/apis/chat/package.json b/src/apis/chat/package.json index dfc63ef16b4..c34af649b4a 100644 --- a/src/apis/chat/package.json +++ b/src/apis/chat/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/chat/webpack.config.js b/src/apis/chat/webpack.config.js index 1111f5c3a07..918e0655f0d 100644 --- a/src/apis/chat/webpack.config.js +++ b/src/apis/chat/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/civicinfo/package.json b/src/apis/civicinfo/package.json index f520495a568..84a2a69aeaa 100644 --- a/src/apis/civicinfo/package.json +++ b/src/apis/civicinfo/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/civicinfo/webpack.config.js b/src/apis/civicinfo/webpack.config.js index 7de5072018f..95612c985f6 100644 --- a/src/apis/civicinfo/webpack.config.js +++ b/src/apis/civicinfo/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/classroom/package.json b/src/apis/classroom/package.json index da83cdd802d..b01aeaf7720 100644 --- a/src/apis/classroom/package.json +++ b/src/apis/classroom/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/classroom/webpack.config.js b/src/apis/classroom/webpack.config.js index 5d0edd68fd0..69de154b734 100644 --- a/src/apis/classroom/webpack.config.js +++ b/src/apis/classroom/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/cloudasset/package.json b/src/apis/cloudasset/package.json index d892252d6fc..0ab9a02bb8e 100644 --- a/src/apis/cloudasset/package.json +++ b/src/apis/cloudasset/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/cloudasset/v1.ts b/src/apis/cloudasset/v1.ts index 01802fc7778..102dc60bc5d 100644 --- a/src/apis/cloudasset/v1.ts +++ b/src/apis/cloudasset/v1.ts @@ -135,6 +135,10 @@ export namespace cloudasset_v1 { * The full name of the asset. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more information. */ name?: string; + /** + * Representation of the Cloud Organization Policy set on an asset. For each asset, there could be multiple Organization policies with different constraints. + */ + orgPolicy?: Schema$GoogleCloudOrgpolicyV1Policy[]; /** * Representation of the resource. */ @@ -247,6 +251,77 @@ export namespace cloudasset_v1 { */ uriPrefix?: string; } + /** + * Used in `policy_type` to specify how `boolean_policy` will behave at this resource. + */ + export interface Schema$GoogleCloudOrgpolicyV1BooleanPolicy { + /** + * If `true`, then the `Policy` is enforced. If `false`, then any configuration is acceptable. Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess` with `constraint_default` set to `ALLOW`. A `Policy` for that `Constraint` exhibits the following behavior: - If the `Policy` at this resource has enforced set to `false`, serial port connection attempts will be allowed. - If the `Policy` at this resource has enforced set to `true`, serial port connection attempts will be refused. - If the `Policy` at this resource is `RestoreDefault`, serial port connection attempts will be allowed. - If no `Policy` is set at this resource or anywhere higher in the resource hierarchy, serial port connection attempts will be allowed. - If no `Policy` is set at this resource, but one exists higher in the resource hierarchy, the behavior is as if the`Policy` were set at this resource. The following examples demonstrate the different possible layerings: Example 1 (nearest `Constraint` wins): `organizations/foo` has a `Policy` with: {enforced: false} `projects/bar` has no `Policy` set. The constraint at `projects/bar` and `organizations/foo` will not be enforced. Example 2 (enforcement gets replaced): `organizations/foo` has a `Policy` with: {enforced: false} `projects/bar` has a `Policy` with: {enforced: true} The constraint at `organizations/foo` is not enforced. The constraint at `projects/bar` is enforced. Example 3 (RestoreDefault): `organizations/foo` has a `Policy` with: {enforced: true} `projects/bar` has a `Policy` with: {RestoreDefault: {}} The constraint at `organizations/foo` is enforced. The constraint at `projects/bar` is not enforced, because `constraint_default` for the `Constraint` is `ALLOW`. + */ + enforced?: boolean; + } + /** + * Used in `policy_type` to specify how `list_policy` behaves at this resource. `ListPolicy` can define specific values and subtrees of Cloud Resource Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or denied by setting the `allowed_values` and `denied_values` fields. This is achieved by using the `under:` and optional `is:` prefixes. The `under:` prefix is used to denote resource subtree values. The `is:` prefix is used to denote specific values, and is required only if the value contains a ":". Values prefixed with "is:" are treated the same as values with no prefix. Ancestry subtrees must be in one of the following formats: - “projects/<project-id>”, e.g. “projects/tokyo-rain-123” - “folders/<folder-id>”, e.g. “folders/1234” - “organizations/<organization-id>”, e.g. “organizations/1234” The `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used. You can set `allowed_values` and `denied_values` in the same `Policy` if `all_values` is `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all values. If `all_values` is set to either `ALLOW` or `DENY`, `allowed_values` and `denied_values` must be unset. + */ + export interface Schema$GoogleCloudOrgpolicyV1ListPolicy { + /** + * List of values allowed at this resource. Can only be set if `all_values` is set to `ALL_VALUES_UNSPECIFIED`. + */ + allowedValues?: string[]; + /** + * The policy all_values state. + */ + allValues?: string; + /** + * List of values denied at this resource. Can only be set if `all_values` is set to `ALL_VALUES_UNSPECIFIED`. + */ + deniedValues?: string[]; + /** + * Determines the inheritance behavior for this `Policy`. By default, a `ListPolicy` set at a resource supercedes any `Policy` set anywhere up the resource hierarchy. However, if `inherit_from_parent` is set to `true`, then the values from the effective `Policy` of the parent resource are inherited, meaning the values set in this `Policy` are added to the values inherited up the hierarchy. Setting `Policy` hierarchies that inherit both allowed values and denied values isn't recommended in most circumstances to keep the configuration simple and understandable. However, it is possible to set a `Policy` with `allowed_values` set that inherits a `Policy` with `denied_values` set. In this case, the values that are allowed must be in `allowed_values` and not present in `denied_values`. For example, suppose you have a `Constraint` `constraints/serviceuser.services`, which has a `constraint_type` of `list_constraint`, and with `constraint_default` set to `ALLOW`. Suppose that at the Organization level, a `Policy` is applied that restricts the allowed API activations to {`E1`, `E2`}. Then, if a `Policy` is applied to a project below the Organization that has `inherit_from_parent` set to `false` and field all_values set to DENY, then an attempt to activate any API will be denied. The following examples demonstrate different possible layerings for `projects/bar` parented by `organizations/foo`: Example 1 (no inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has `inherit_from_parent` `false` and values: {allowed_values: "E3" allowed_values: "E4"} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E3`, and `E4`. Example 2 (inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a `Policy` with values: {value: “E3” value: ”E4” inherit_from_parent: true} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`. Example 3 (inheriting both allowed and denied values): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a `Policy` with: {denied_values: "E1"} The accepted values at `organizations/foo` are `E1`, `E2`. The value accepted at `projects/bar` is `E2`. Example 4 (RestoreDefault): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a `Policy` with values: {RestoreDefault: {}} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 5 (no policy inherits parent policy): `organizations/foo` has no `Policy` set. `projects/bar` has no `Policy` set. The accepted values at both levels are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 6 (ListConstraint allowing all): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: ALLOW} The accepted values at `organizations/foo` are `E1`, E2`. Any value is accepted at `projects/bar`. Example 7 (ListConstraint allowing none): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: DENY} The accepted values at `organizations/foo` are `E1`, E2`. No value is accepted at `projects/bar`. Example 10 (allowed and denied subtrees of Resource Manager hierarchy): Given the following resource hierarchy O1->{F1, F2}; F1->{P1}; F2->{P2, P3}, `organizations/foo` has a `Policy` with values: {allowed_values: "under:organizations/O1"} `projects/bar` has a `Policy` with: {allowed_values: "under:projects/P3"} {denied_values: "under:folders/F2"} The accepted values at `organizations/foo` are `organizations/O1`, `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`, `projects/P3`. The accepted values at `projects/bar` are `organizations/O1`, `folders/F1`, `projects/P1`. + */ + inheritFromParent?: boolean; + /** + * Optional. The Google Cloud Console will try to default to a configuration that matches the value specified in this `Policy`. If `suggested_value` is not set, it will inherit the value specified higher in the hierarchy, unless `inherit_from_parent` is `false`. + */ + suggestedValue?: string; + } + /** + * Defines a Cloud Organization `Policy` which is used to specify `Constraints` for configurations of Cloud Platform resources. + */ + export interface Schema$GoogleCloudOrgpolicyV1Policy { + /** + * For boolean `Constraints`, whether to enforce the `Constraint` or not. + */ + booleanPolicy?: Schema$GoogleCloudOrgpolicyV1BooleanPolicy; + /** + * The name of the `Constraint` the `Policy` is configuring, for example, `constraints/serviceuser.services`. Immutable after creation. + */ + constraint?: string; + /** + * An opaque tag indicating the current version of the `Policy`, used for concurrency control. When the `Policy` is returned from either a `GetPolicy` or a `ListOrgPolicy` request, this `etag` indicates the version of the current `Policy` to use when executing a read-modify-write loop. When the `Policy` is returned from a `GetEffectivePolicy` request, the `etag` will be unset. When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value that was returned from a `GetOrgPolicy` request as part of a read-modify-write loop for concurrency control. Not setting the `etag`in a `SetOrgPolicy` request will result in an unconditional write of the `Policy`. + */ + etag?: string; + /** + * List of values either allowed or disallowed. + */ + listPolicy?: Schema$GoogleCloudOrgpolicyV1ListPolicy; + /** + * Restores the default behavior of the constraint; independent of `Constraint` type. + */ + restoreDefault?: Schema$GoogleCloudOrgpolicyV1RestoreDefault; + /** + * The time stamp the `Policy` was previously updated. This is set by the server, not specified by the caller, and represents the last time a call to `SetOrgPolicy` was made for that `Policy`. Any value set by the client will be ignored. + */ + updateTime?: string; + /** + * Version of the `Policy`. Default version is 0; + */ + version?: number; + } + /** + * Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific `Constraint` at this resource. Suppose that `constraint_default` is set to `ALLOW` for the `Constraint` `constraints/serviceuser.services`. Suppose that organization foo.com sets a `Policy` at their Organization resource node that restricts the allowed service activations to deny all service activations. They could then set a `Policy` with the `policy_type` `restore_default` on several experimental projects, restoring the `constraint_default` enforcement of the `Constraint` for only those projects, allowing those projects to have all services activated. + */ + export interface Schema$GoogleCloudOrgpolicyV1RestoreDefault {} /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -264,7 +339,7 @@ export namespace cloudasset_v1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -332,7 +407,7 @@ export namespace cloudasset_v1 { version?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/cloudasset/v1beta1.ts b/src/apis/cloudasset/v1beta1.ts index 261c803788a..66a7fb934f4 100644 --- a/src/apis/cloudasset/v1beta1.ts +++ b/src/apis/cloudasset/v1beta1.ts @@ -266,7 +266,7 @@ export namespace cloudasset_v1beta1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -334,7 +334,7 @@ export namespace cloudasset_v1beta1 { version?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/cloudasset/webpack.config.js b/src/apis/cloudasset/webpack.config.js index 559ce7d742d..2fc4f2e1894 100644 --- a/src/apis/cloudasset/webpack.config.js +++ b/src/apis/cloudasset/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/cloudbilling/package.json b/src/apis/cloudbilling/package.json index a092fa4ec55..a379aa97d84 100644 --- a/src/apis/cloudbilling/package.json +++ b/src/apis/cloudbilling/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/cloudbilling/v1.ts b/src/apis/cloudbilling/v1.ts index 0f25f2ae498..d2bb4c51f5a 100644 --- a/src/apis/cloudbilling/v1.ts +++ b/src/apis/cloudbilling/v1.ts @@ -133,7 +133,7 @@ export namespace cloudbilling_v1 { aggregationLevel?: string; } /** - * 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. + * 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:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -146,13 +146,17 @@ export namespace cloudbilling_v1 { 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. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.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[]; + /** + * Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored. + */ + ignoreChildExemptions?: boolean; /** * The log type that this config enables. */ @@ -188,7 +192,7 @@ export namespace cloudbilling_v1 { */ 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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * 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@example.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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** @@ -320,7 +324,7 @@ export namespace cloudbilling_v1 { */ 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` 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. */ etag?: string; /** @@ -517,6 +521,53 @@ export namespace cloudbilling_v1 { /** * cloudbilling.billingAccounts.create * @desc Creates a billing account. This method can only be used to create [billing subaccounts](https://cloud.google.com/billing/docs/concepts) by GCP resellers. When creating a subaccount, the current authenticated user must have the `billing.accounts.update` IAM permission on the master account, which is typically given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). This method will return an error if the master account has not been provisioned as a reseller account. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Billing API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudbilling + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudbilling = google.cloudbilling('v1'); + * + * authorize(function(authClient) { + * var request = { + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudbilling.billingAccounts.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudbilling.billingAccounts.create * @memberOf! () * @@ -594,7 +645,7 @@ export namespace cloudbilling_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Billing API + * // 1. If not already done, enable the Cloud Billing API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudbilling * // 2. This sample uses Application Default Credentials for authentication. @@ -606,7 +657,7 @@ export namespace cloudbilling_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudbilling = google.cloudbilling('v1'); * * authorize(function(authClient) { @@ -630,16 +681,12 @@ export namespace cloudbilling_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudbilling.billingAccounts.get @@ -713,10 +760,58 @@ export namespace cloudbilling_v1 { /** * cloudbilling.billingAccounts.getIamPolicy * @desc Gets the access control policy for a billing account. The caller must have the `billing.accounts.getIamPolicy` permission on the account, which is often given to billing account [viewers](https://cloud.google.com/billing/docs/how-to/billing-access). + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Billing API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudbilling + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudbilling = google.cloudbilling('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'billingAccounts/my-billing-account', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudbilling.billingAccounts.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudbilling.billingAccounts.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -788,7 +883,7 @@ export namespace cloudbilling_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Billing API + * // 1. If not already done, enable the Cloud Billing API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudbilling * // 2. This sample uses Application Default Credentials for authentication. @@ -800,7 +895,7 @@ export namespace cloudbilling_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudbilling = google.cloudbilling('v1'); * * authorize(function(authClient) { @@ -833,16 +928,12 @@ export namespace cloudbilling_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudbilling.billingAccounts.list @@ -928,6 +1019,57 @@ export namespace cloudbilling_v1 { /** * cloudbilling.billingAccounts.patch * @desc Updates a billing account's fields. Currently the only field that can be edited is `display_name`. The current authenticated user must have the `billing.accounts.update` IAM permission, which is typically given to the [administrator](https://cloud.google.com/billing/docs/how-to/billing-access) of the billing account. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Billing API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudbilling + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudbilling = google.cloudbilling('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the billing account resource to be updated. + * name: 'billingAccounts/my-billing-account', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * cloudbilling.billingAccounts.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudbilling.billingAccounts.patch * @memberOf! () * @@ -1001,6 +1143,57 @@ export namespace cloudbilling_v1 { /** * cloudbilling.billingAccounts.setIamPolicy * @desc Sets the access control policy for a billing account. Replaces any existing policy. The caller must have the `billing.accounts.setIamPolicy` permission on the account, which is often given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Billing API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudbilling + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudbilling = google.cloudbilling('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'billingAccounts/my-billing-account', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudbilling.billingAccounts.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudbilling.billingAccounts.setIamPolicy * @memberOf! () * @@ -1074,6 +1267,57 @@ export namespace cloudbilling_v1 { /** * cloudbilling.billingAccounts.testIamPermissions * @desc Tests the access control policy for a billing account. This method takes the resource and a set of permissions as input and returns the subset of the input permissions that the caller is allowed for that resource. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Billing API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudbilling + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudbilling = google.cloudbilling('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'billingAccounts/my-billing-account', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudbilling.billingAccounts.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudbilling.billingAccounts.testIamPermissions * @memberOf! () * @@ -1185,6 +1429,10 @@ export namespace cloudbilling_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ @@ -1278,7 +1526,7 @@ export namespace cloudbilling_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Billing API + * // 1. If not already done, enable the Cloud Billing API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudbilling * // 2. This sample uses Application Default Credentials for authentication. @@ -1290,7 +1538,7 @@ export namespace cloudbilling_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudbilling = google.cloudbilling('v1'); * * authorize(function(authClient) { @@ -1327,16 +1575,12 @@ export namespace cloudbilling_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudbilling.billingAccounts.projects.list @@ -1455,7 +1699,7 @@ export namespace cloudbilling_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Billing API + * // 1. If not already done, enable the Cloud Billing API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudbilling * // 2. This sample uses Application Default Credentials for authentication. @@ -1467,7 +1711,7 @@ export namespace cloudbilling_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudbilling = google.cloudbilling('v1'); * * authorize(function(authClient) { @@ -1491,16 +1735,12 @@ export namespace cloudbilling_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudbilling.projects.getBillingInfo @@ -1582,7 +1822,7 @@ export namespace cloudbilling_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Billing API + * // 1. If not already done, enable the Cloud Billing API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudbilling * // 2. This sample uses Application Default Credentials for authentication. @@ -1594,7 +1834,7 @@ export namespace cloudbilling_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudbilling = google.cloudbilling('v1'); * * authorize(function(authClient) { @@ -1623,16 +1863,12 @@ export namespace cloudbilling_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudbilling.projects.updateBillingInfo @@ -1754,7 +1990,7 @@ export namespace cloudbilling_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Billing API + * // 1. If not already done, enable the Cloud Billing API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudbilling * // 2. This sample uses Application Default Credentials for authentication. @@ -1766,7 +2002,7 @@ export namespace cloudbilling_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudbilling = google.cloudbilling('v1'); * * authorize(function(authClient) { @@ -1799,16 +2035,12 @@ export namespace cloudbilling_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudbilling.services.list @@ -1910,7 +2142,7 @@ export namespace cloudbilling_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Billing API + * // 1. If not already done, enable the Cloud Billing API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudbilling * // 2. This sample uses Application Default Credentials for authentication. @@ -1922,7 +2154,7 @@ export namespace cloudbilling_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudbilling = google.cloudbilling('v1'); * * authorize(function(authClient) { @@ -1959,16 +2191,12 @@ export namespace cloudbilling_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudbilling.services.skus.list diff --git a/src/apis/cloudbilling/webpack.config.js b/src/apis/cloudbilling/webpack.config.js index 1d9742ff852..a925beb664d 100644 --- a/src/apis/cloudbilling/webpack.config.js +++ b/src/apis/cloudbilling/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/cloudbuild/package.json b/src/apis/cloudbuild/package.json index fe1bf817fe8..1082af61532 100644 --- a/src/apis/cloudbuild/package.json +++ b/src/apis/cloudbuild/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index 1970b736df3..10c19ff613c 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -448,10 +448,6 @@ export namespace cloudbuild_v1 { * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} - /** - * A CheckSuiteFilter is a filter that indicates that we should build on all check suite events. - */ - export interface Schema$CheckSuiteFilter {} /** * 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 `{}`. */ @@ -470,19 +466,15 @@ export namespace cloudbuild_v1 { */ export interface Schema$GitHubEventsConfig { /** - * Output only. Indicates that a build was generated from a check suite event. - */ - checkSuite?: Schema$CheckSuiteFilter; - /** - * The installationID that emmits the GitHub event. + * The installationID that emits the GitHub event. */ installationId?: string; /** - * Name of the repository. + * Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders". */ name?: string; /** - * Owner of the repository. + * Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform". */ owner?: string; /** @@ -703,7 +695,7 @@ export namespace cloudbuild_v1 { resolvedStorageSource?: Schema$StorageSource; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/cloudbuild/webpack.config.js b/src/apis/cloudbuild/webpack.config.js index 8c6b910835e..b204cca3f0d 100644 --- a/src/apis/cloudbuild/webpack.config.js +++ b/src/apis/cloudbuild/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/clouddebugger/package.json b/src/apis/clouddebugger/package.json index 2eaf1ef4f56..6f729c13fd7 100644 --- a/src/apis/clouddebugger/package.json +++ b/src/apis/clouddebugger/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/clouddebugger/v2.ts b/src/apis/clouddebugger/v2.ts index 36adf5299c1..a4ba6ee9c67 100644 --- a/src/apis/clouddebugger/v2.ts +++ b/src/apis/clouddebugger/v2.ts @@ -622,7 +622,7 @@ export namespace clouddebugger_v2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudDebugger = google.clouddebugger('v2'); * * authorize(function(authClient) { @@ -646,16 +646,12 @@ export namespace clouddebugger_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias clouddebugger.controller.debuggees.register @@ -772,7 +768,7 @@ export namespace clouddebugger_v2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudDebugger = google.clouddebugger('v2'); * * authorize(function(authClient) { @@ -795,16 +791,12 @@ export namespace clouddebugger_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias clouddebugger.controller.debuggees.breakpoints.list @@ -907,7 +899,7 @@ export namespace clouddebugger_v2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudDebugger = google.clouddebugger('v2'); * * authorize(function(authClient) { @@ -938,16 +930,12 @@ export namespace clouddebugger_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias clouddebugger.controller.debuggees.breakpoints.update @@ -1112,7 +1100,7 @@ export namespace clouddebugger_v2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudDebugger = google.clouddebugger('v2'); * * authorize(function(authClient) { @@ -1132,16 +1120,12 @@ export namespace clouddebugger_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias clouddebugger.debugger.debuggees.list @@ -1266,7 +1250,7 @@ export namespace clouddebugger_v2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudDebugger = google.clouddebugger('v2'); * * authorize(function(authClient) { @@ -1289,16 +1273,12 @@ export namespace clouddebugger_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias clouddebugger.debugger.debuggees.breakpoints.delete @@ -1391,7 +1371,7 @@ export namespace clouddebugger_v2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudDebugger = google.clouddebugger('v2'); * * authorize(function(authClient) { @@ -1417,16 +1397,12 @@ export namespace clouddebugger_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias clouddebugger.debugger.debuggees.breakpoints.get @@ -1523,7 +1499,7 @@ export namespace clouddebugger_v2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudDebugger = google.clouddebugger('v2'); * * authorize(function(authClient) { @@ -1546,16 +1522,12 @@ export namespace clouddebugger_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias clouddebugger.debugger.debuggees.breakpoints.list @@ -1655,7 +1627,7 @@ export namespace clouddebugger_v2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudDebugger = google.clouddebugger('v2'); * * authorize(function(authClient) { @@ -1682,16 +1654,12 @@ export namespace clouddebugger_v2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias clouddebugger.debugger.debuggees.breakpoints.set diff --git a/src/apis/clouddebugger/webpack.config.js b/src/apis/clouddebugger/webpack.config.js index a2c02db3eb2..39455c97328 100644 --- a/src/apis/clouddebugger/webpack.config.js +++ b/src/apis/clouddebugger/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/clouderrorreporting/package.json b/src/apis/clouderrorreporting/package.json index 4feb29c0a43..d3dc18771b3 100644 --- a/src/apis/clouderrorreporting/package.json +++ b/src/apis/clouderrorreporting/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/clouderrorreporting/webpack.config.js b/src/apis/clouderrorreporting/webpack.config.js index 0ad4d23f9ff..8228b31ca6f 100644 --- a/src/apis/clouderrorreporting/webpack.config.js +++ b/src/apis/clouderrorreporting/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/cloudfunctions/package.json b/src/apis/cloudfunctions/package.json index 8b65f3832d5..fcd6ce26636 100644 --- a/src/apis/cloudfunctions/package.json +++ b/src/apis/cloudfunctions/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index 969132db090..b2a5676c8de 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -445,7 +445,7 @@ export namespace cloudfunctions_v1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -555,7 +555,7 @@ export namespace cloudfunctions_v1 { url?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/cloudfunctions/v1beta2.ts b/src/apis/cloudfunctions/v1beta2.ts index d55dca74ad6..a5e6becd08f 100644 --- a/src/apis/cloudfunctions/v1beta2.ts +++ b/src/apis/cloudfunctions/v1beta2.ts @@ -385,7 +385,7 @@ export namespace cloudfunctions_v1beta2 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -477,7 +477,7 @@ export namespace cloudfunctions_v1beta2 { tag?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/cloudfunctions/webpack.config.js b/src/apis/cloudfunctions/webpack.config.js index 398a5a95be5..7e381f7b1b2 100644 --- a/src/apis/cloudfunctions/webpack.config.js +++ b/src/apis/cloudfunctions/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/cloudidentity/package.json b/src/apis/cloudidentity/package.json index 5bb6fa2b4ac..e023bd9a2be 100644 --- a/src/apis/cloudidentity/package.json +++ b/src/apis/cloudidentity/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/cloudidentity/v1.ts b/src/apis/cloudidentity/v1.ts index e93f6d8ec05..6e4c0bbfb81 100644 --- a/src/apis/cloudidentity/v1.ts +++ b/src/apis/cloudidentity/v1.ts @@ -272,7 +272,7 @@ export namespace cloudidentity_v1 { nextPageToken?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/cloudidentity/v1beta1.ts b/src/apis/cloudidentity/v1beta1.ts index 463b6359a76..507638f91fa 100644 --- a/src/apis/cloudidentity/v1beta1.ts +++ b/src/apis/cloudidentity/v1beta1.ts @@ -263,7 +263,7 @@ export namespace cloudidentity_v1beta1 { nextPageToken?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/cloudidentity/webpack.config.js b/src/apis/cloudidentity/webpack.config.js index bc82f365506..159b8b3a5ac 100644 --- a/src/apis/cloudidentity/webpack.config.js +++ b/src/apis/cloudidentity/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/cloudiot/package.json b/src/apis/cloudiot/package.json index 4fdaa8ee7ec..2ad41a51c0e 100644 --- a/src/apis/cloudiot/package.json +++ b/src/apis/cloudiot/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/cloudiot/v1.ts b/src/apis/cloudiot/v1.ts index a3315ad3231..b9d7753ef2a 100644 --- a/src/apis/cloudiot/v1.ts +++ b/src/apis/cloudiot/v1.ts @@ -370,7 +370,21 @@ export namespace cloudiot_v1 { /** * Request message for `GetIamPolicy` method. */ - export interface Schema$GetIamPolicyRequest {} + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + */ + options?: Schema$GetPolicyOptions; + } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + requestedPolicyVersion?: number; + } /** * The configuration of the HTTP bridge for a device registry. */ @@ -538,7 +552,7 @@ export namespace cloudiot_v1 { pubsubTopicName?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -2489,88 +2503,6 @@ export namespace cloudiot_v1 { ); } - /** - * cloudiot.projects.locations.registries.groups.bindDeviceToGateway - * @desc Associates the device with the gateway. - * @alias cloudiot.projects.locations.registries.groups.bindDeviceToGateway - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. - * @param {().BindDeviceToGatewayRequest} 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 - */ - bindDeviceToGateway( - params?: Params$Resource$Projects$Locations$Registries$Groups$Binddevicetogateway, - options?: MethodOptions - ): GaxiosPromise; - bindDeviceToGateway( - params: Params$Resource$Projects$Locations$Registries$Groups$Binddevicetogateway, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - bindDeviceToGateway( - params: Params$Resource$Projects$Locations$Registries$Groups$Binddevicetogateway, - callback: BodyResponseCallback - ): void; - bindDeviceToGateway( - callback: BodyResponseCallback - ): void; - bindDeviceToGateway( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Registries$Groups$Binddevicetogateway - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Registries$Groups$Binddevicetogateway; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Registries$Groups$Binddevicetogateway; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudiot.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}:bindDeviceToGateway').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * cloudiot.projects.locations.registries.groups.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. @@ -2798,109 +2730,8 @@ export namespace cloudiot_v1 { return createAPIRequest(parameters); } } - - /** - * cloudiot.projects.locations.registries.groups.unbindDeviceFromGateway - * @desc Deletes the association between the device and the gateway. - * @alias cloudiot.projects.locations.registries.groups.unbindDeviceFromGateway - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. - * @param {().UnbindDeviceFromGatewayRequest} 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 - */ - unbindDeviceFromGateway( - params?: Params$Resource$Projects$Locations$Registries$Groups$Unbinddevicefromgateway, - options?: MethodOptions - ): GaxiosPromise; - unbindDeviceFromGateway( - params: Params$Resource$Projects$Locations$Registries$Groups$Unbinddevicefromgateway, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - unbindDeviceFromGateway( - params: Params$Resource$Projects$Locations$Registries$Groups$Unbinddevicefromgateway, - callback: BodyResponseCallback - ): void; - unbindDeviceFromGateway( - callback: BodyResponseCallback - ): void; - unbindDeviceFromGateway( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Registries$Groups$Unbinddevicefromgateway - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Registries$Groups$Unbinddevicefromgateway; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Registries$Groups$Unbinddevicefromgateway; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudiot.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}:unbindDeviceFromGateway').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } } - export interface Params$Resource$Projects$Locations$Registries$Groups$Binddevicetogateway - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BindDeviceToGatewayRequest; - } export interface Params$Resource$Projects$Locations$Registries$Groups$Getiampolicy extends StandardParameters { /** @@ -2952,106 +2783,11 @@ export namespace cloudiot_v1 { */ requestBody?: Schema$TestIamPermissionsRequest; } - export interface Params$Resource$Projects$Locations$Registries$Groups$Unbinddevicefromgateway - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UnbindDeviceFromGatewayRequest; - } export class Resource$Projects$Locations$Registries$Groups$Devices { context: APIRequestContext; - configVersions: Resource$Projects$Locations$Registries$Groups$Devices$Configversions; - states: Resource$Projects$Locations$Registries$Groups$Devices$States; constructor(context: APIRequestContext) { this.context = context; - this.configVersions = new Resource$Projects$Locations$Registries$Groups$Devices$Configversions( - this.context - ); - this.states = new Resource$Projects$Locations$Registries$Groups$Devices$States( - this.context - ); - } - - /** - * cloudiot.projects.locations.registries.groups.devices.get - * @desc Gets details about a device. - * @alias cloudiot.projects.locations.registries.groups.devices.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.fieldMask The fields of the `Device` resource to be returned in the response. If the field mask is unset or empty, all fields are returned. - * @param {string} params.name The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_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$Locations$Registries$Groups$Devices$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Registries$Groups$Devices$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Registries$Groups$Devices$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Registries$Groups$Devices$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Registries$Groups$Devices$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Registries$Groups$Devices$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudiot.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } } /** @@ -3135,254 +2871,8 @@ export namespace cloudiot_v1 { return createAPIRequest(parameters); } } - - /** - * cloudiot.projects.locations.registries.groups.devices.modifyCloudToDeviceConfig - * @desc Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata. - * @alias cloudiot.projects.locations.registries.groups.devices.modifyCloudToDeviceConfig - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. - * @param {().ModifyCloudToDeviceConfigRequest} 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 - */ - modifyCloudToDeviceConfig( - params?: Params$Resource$Projects$Locations$Registries$Groups$Devices$Modifycloudtodeviceconfig, - options?: MethodOptions - ): GaxiosPromise; - modifyCloudToDeviceConfig( - params: Params$Resource$Projects$Locations$Registries$Groups$Devices$Modifycloudtodeviceconfig, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - modifyCloudToDeviceConfig( - params: Params$Resource$Projects$Locations$Registries$Groups$Devices$Modifycloudtodeviceconfig, - callback: BodyResponseCallback - ): void; - modifyCloudToDeviceConfig( - callback: BodyResponseCallback - ): void; - modifyCloudToDeviceConfig( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Registries$Groups$Devices$Modifycloudtodeviceconfig - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Registries$Groups$Devices$Modifycloudtodeviceconfig; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Registries$Groups$Devices$Modifycloudtodeviceconfig; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudiot.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:modifyCloudToDeviceConfig').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * cloudiot.projects.locations.registries.groups.devices.patch - * @desc Updates a device. - * @alias cloudiot.projects.locations.registries.groups.devices.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource path name. For example, `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or `projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`. When `name` is populated as a response from the service, it always ends in the device numeric ID. - * @param {string=} params.updateMask Only updates the `device` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `credentials`, `blocked`, and `metadata` - * @param {().Device} 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$Locations$Registries$Groups$Devices$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Registries$Groups$Devices$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Registries$Groups$Devices$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Registries$Groups$Devices$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Registries$Groups$Devices$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Registries$Groups$Devices$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudiot.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * cloudiot.projects.locations.registries.groups.devices.sendCommandToDevice - * @desc Sends a command to the specified device. In order for a device to be able to receive commands, it must: 1) be connected to Cloud IoT Core using the MQTT protocol, and 2) be subscribed to the group of MQTT topics specified by /devices/{device-id}/commands/#. This subscription will receive commands at the top-level topic /devices/{device-id}/commands as well as commands for subfolders, like /devices/{device-id}/commands/subfolder. Note that subscribing to specific subfolders is not supported. If the command could not be delivered to the device, this method will return an error; in particular, if the device is not subscribed, this method will return FAILED_PRECONDITION. Otherwise, this method will return OK. If the subscription is QoS 1, at least once delivery will be guaranteed; for QoS 0, no acknowledgment will be expected from the device. - * @alias cloudiot.projects.locations.registries.groups.devices.sendCommandToDevice - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. - * @param {().SendCommandToDeviceRequest} 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 - */ - sendCommandToDevice( - params?: Params$Resource$Projects$Locations$Registries$Groups$Devices$Sendcommandtodevice, - options?: MethodOptions - ): GaxiosPromise; - sendCommandToDevice( - params: Params$Resource$Projects$Locations$Registries$Groups$Devices$Sendcommandtodevice, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - sendCommandToDevice( - params: Params$Resource$Projects$Locations$Registries$Groups$Devices$Sendcommandtodevice, - callback: BodyResponseCallback - ): void; - sendCommandToDevice( - callback: BodyResponseCallback - ): void; - sendCommandToDevice( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Registries$Groups$Devices$Sendcommandtodevice - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Registries$Groups$Devices$Sendcommandtodevice; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Registries$Groups$Devices$Sendcommandtodevice; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudiot.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:sendCommandToDevice').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } } - export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The fields of the `Device` resource to be returned in the response. If the field mask is unset or empty, all fields are returned. - */ - fieldMask?: string; - /** - * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. - */ - name?: string; - } export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$List extends StandardParameters { /** @@ -3427,265 +2917,4 @@ export namespace cloudiot_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$Modifycloudtodeviceconfig - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ModifyCloudToDeviceConfigRequest; - } - export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource path name. For example, `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or `projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`. When `name` is populated as a response from the service, it always ends in the device numeric ID. - */ - name?: string; - /** - * Only updates the `device` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `credentials`, `blocked`, and `metadata` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Device; - } - export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$Sendcommandtodevice - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SendCommandToDeviceRequest; - } - - export class Resource$Projects$Locations$Registries$Groups$Devices$Configversions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * cloudiot.projects.locations.registries.groups.devices.configVersions.list - * @desc Lists the last few versions of the device configuration in descending order (i.e.: newest first). - * @alias cloudiot.projects.locations.registries.groups.devices.configVersions.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. - * @param {integer=} params.numVersions The number of versions to list. Versions are listed in decreasing order of the version number. The maximum number of versions retained is 10. If this value is zero, it will return all the versions available. - * @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$Registries$Groups$Devices$Configversions$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Registries$Groups$Devices$Configversions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Registries$Groups$Devices$Configversions$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Registries$Groups$Devices$Configversions$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Registries$Groups$Devices$Configversions$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Registries$Groups$Devices$Configversions$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudiot.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}/configVersions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$Configversions$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. - */ - name?: string; - /** - * The number of versions to list. Versions are listed in decreasing order of the version number. The maximum number of versions retained is 10. If this value is zero, it will return all the versions available. - */ - numVersions?: number; - } - - export class Resource$Projects$Locations$Registries$Groups$Devices$States { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * cloudiot.projects.locations.registries.groups.devices.states.list - * @desc Lists the last few versions of the device state in descending order (i.e.: newest first). - * @alias cloudiot.projects.locations.registries.groups.devices.states.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. - * @param {integer=} params.numStates The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available. - * @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$Registries$Groups$Devices$States$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Registries$Groups$Devices$States$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Registries$Groups$Devices$States$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Registries$Groups$Devices$States$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Registries$Groups$Devices$States$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Registries$Groups$Devices$States$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudiot.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}/states').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Registries$Groups$Devices$States$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. - */ - name?: string; - /** - * The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available. - */ - numStates?: number; - } } diff --git a/src/apis/cloudiot/webpack.config.js b/src/apis/cloudiot/webpack.config.js index a9f38ef8509..9809730c351 100644 --- a/src/apis/cloudiot/webpack.config.js +++ b/src/apis/cloudiot/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/cloudkms/package.json b/src/apis/cloudkms/package.json index 415221520b8..f7c0fe982a2 100644 --- a/src/apis/cloudkms/package.json +++ b/src/apis/cloudkms/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index 6a9bf894321..41ff0660dba 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -225,7 +225,7 @@ export namespace cloudkms_v1 { */ purpose?: string; /** - * next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least one day. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. + * next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. */ rotationPeriod?: string; /** @@ -261,6 +261,18 @@ export namespace cloudkms_v1 { * Output only. The time this CryptoKeyVersion's key material was generated. */ generateTime?: string; + /** + * Output only. The root cause of an import failure. Only present if state is IMPORT_FAILED. + */ + importFailureReason?: string; + /** + * Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported. + */ + importJob?: string; + /** + * Output only. The time at which this CryptoKeyVersion's key material was imported. + */ + importTime?: string; /** * Output only. The resource name for this CryptoKeyVersion in the format `projects/x/locations/x/keyRings/x/cryptoKeys/x/cryptoKeyVersions/x. */ @@ -377,6 +389,68 @@ export namespace cloudkms_v1 { */ title?: string; } + /** + * Request message for KeyManagementService.ImportCryptoKeyVersion. + */ + export interface Schema$ImportCryptoKeyVersionRequest { + /** + * Required. The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into. + */ + algorithm?: string; + /** + * Required. The name of the ImportJob that was used to wrap this key material. + */ + importJob?: string; + /** + * Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256. This field contains the concatenation of two wrapped keys: <ol> <li>An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1, MGF1 with SHA-1, and an empty label. </li> <li>The key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). </li> </ol> This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP. + */ + rsaAesWrappedKey?: string; + } + /** + * An ImportJob can be used to create CryptoKeys and CryptoKeyVersions using pre-existing key material, generated outside of Cloud KMS. When an ImportJob is created, Cloud KMS will generate a "wrapping key", which is a public/private key pair. You use the wrapping key to encrypt (also known as wrap) the pre-existing key material to protect it during the import process. The nature of the wrapping key depends on the choice of import_method. When the wrapping key generation is complete, the state will be set to ACTIVE and the public_key can be fetched. The fetched public key can then be used to wrap your pre-existing key material. Once the key material is wrapped, it can be imported into a new CryptoKeyVersion in an existing CryptoKey by calling ImportCryptoKeyVersion. Multiple CryptoKeyVersions can be imported with a single ImportJob. Cloud KMS uses the private key portion of the wrapping key to unwrap the key material. Only Cloud KMS has access to the private key. An ImportJob expires 3 days after it is created. Once expired, Cloud KMS will no longer be able to import or unwrap any key material that was wrapped with the ImportJob's public key. For more information, see [Importing a key](https://cloud.google.com/kms/docs/importing-a-key). + */ + export interface Schema$ImportJob { + /** + * Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only present if the chosen ImportMethod is one with a protection level of HSM. + */ + attestation?: Schema$KeyOperationAttestation; + /** + * Output only. The time at which this ImportJob was created. + */ + createTime?: string; + /** + * Output only. The time this ImportJob expired. Only present if state is EXPIRED. + */ + expireEventTime?: string; + /** + * Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material. + */ + expireTime?: string; + /** + * Output only. The time this ImportJob's key material was generated. + */ + generateTime?: string; + /** + * Required and immutable. The wrapping method to be used for incoming key material. + */ + importMethod?: string; + /** + * Output only. The resource name for this ImportJob in the format `projects/x/locations/x/keyRings/x/importJobs/x. + */ + name?: string; + /** + * Required and immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. + */ + protectionLevel?: string; + /** + * Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE. + */ + publicKey?: Schema$WrappingPublicKey; + /** + * Output only. The current state of the ImportJob, indicating if it can be used. + */ + state?: string; + } /** * Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). */ @@ -437,6 +511,23 @@ export namespace cloudkms_v1 { */ totalSize?: number; } + /** + * Response message for KeyManagementService.ListImportJobs. + */ + export interface Schema$ListImportJobsResponse { + /** + * The list of ImportJobs. + */ + importJobs?: Schema$ImportJob[]; + /** + * A token to retrieve next page of results. Pass this value in ListImportJobsRequest.page_token to retrieve the next page of results. + */ + nextPageToken?: string; + /** + * The total number of ImportJobs that matched the query. + */ + totalSize?: number; + } /** * Response message for KeyManagementService.ListKeyRings. */ @@ -579,6 +670,15 @@ export namespace cloudkms_v1 { */ cryptoKeyVersionId?: string; } + /** + * The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod. + */ + export interface Schema$WrappingPublicKey { + /** + * The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). + */ + pem?: string; + } export class Resource$Projects { context: APIRequestContext; @@ -947,6 +1047,7 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1019,6 +1120,8 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.filter Optional. Only include resources that match the filter in the response (https://cloud.google.com/kms/docs/sorting-and-filtering). + * @param {string=} params.orderBy Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order (https://cloud.google.com/kms/docs/sorting-and-filtering). * @param {integer=} params.pageSize Optional limit on the number of KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token. * @param {string} params.parent Required. The resource name of the location associated with the KeyRings, in the format `projects/x/locations/x`. @@ -1286,6 +1389,10 @@ export namespace cloudkms_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ @@ -1298,6 +1405,14 @@ export namespace cloudkms_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. Only include resources that match the filter in the response (https://cloud.google.com/kms/docs/sorting-and-filtering). + */ + filter?: string; + /** + * Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order (https://cloud.google.com/kms/docs/sorting-and-filtering). + */ + orderBy?: string; /** * Optional limit on the number of KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. */ @@ -1365,6 +1480,7 @@ export namespace cloudkms_v1 { * @param {object} params Parameters for request * @param {string=} params.cryptoKeyId Required. It must be unique within a KeyRing and match the regular expression `[a-zA-Z0-9_-]{1,63}` * @param {string} params.parent Required. The name of the KeyRing associated with the CryptoKeys. + * @param {boolean=} params.skipInitialVersionCreation If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use this CryptoKey. * @param {().CryptoKey} 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. @@ -1660,6 +1776,7 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1732,6 +1849,8 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.filter Optional. Only include resources that match the filter in the response (https://cloud.google.com/kms/docs/sorting-and-filtering). + * @param {string=} params.orderBy Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order (https://cloud.google.com/kms/docs/sorting-and-filtering). * @param {integer=} params.pageSize Optional limit on the number of CryptoKeys to include in the response. Further CryptoKeys can subsequently be obtained by including the ListCryptoKeysResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken Optional pagination token, returned earlier via ListCryptoKeysResponse.next_page_token. * @param {string} params.parent Required. The resource name of the KeyRing to list, in the format `projects/x/locations/x/keyRings/x`. @@ -2125,6 +2244,10 @@ export namespace cloudkms_v1 { * Required. The name of the KeyRing associated with the CryptoKeys. */ parent?: string; + /** + * If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use this CryptoKey. + */ + skipInitialVersionCreation?: boolean; /** * Request body metadata @@ -2184,6 +2307,10 @@ export namespace cloudkms_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ @@ -2196,6 +2323,14 @@ export namespace cloudkms_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. Only include resources that match the filter in the response (https://cloud.google.com/kms/docs/sorting-and-filtering). + */ + filter?: string; + /** + * Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order (https://cloud.google.com/kms/docs/sorting-and-filtering). + */ + orderBy?: string; /** * Optional limit on the number of CryptoKeys to include in the response. Further CryptoKeys can subsequently be obtained by including the ListCryptoKeysResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. */ @@ -2748,6 +2883,81 @@ export namespace cloudkms_v1 { } } + /** + * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.import + * @desc Imports a new CryptoKeyVersion into an existing CryptoKey using the wrapped key material provided in the request. The version ID will be assigned the next sequential id within the CryptoKey. + * @alias cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.import + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The name of the CryptoKey to be imported into. + * @param {().ImportCryptoKeyVersionRequest} 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 + */ + import( + params?: Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Import, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Import, + callback: BodyResponseCallback + ): void; + import(callback: BodyResponseCallback): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Import + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudkms.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/cryptoKeyVersions:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list * @desc Lists CryptoKeyVersions. @@ -2755,6 +2965,8 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.filter Optional. Only include resources that match the filter in the response (https://cloud.google.com/kms/docs/sorting-and-filtering). + * @param {string=} params.orderBy Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order (https://cloud.google.com/kms/docs/sorting-and-filtering). * @param {integer=} params.pageSize Optional limit on the number of CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken Optional pagination token, returned earlier via ListCryptoKeyVersionsResponse.next_page_token. * @param {string} params.parent Required. The resource name of the CryptoKey to list, in the format `projects/x/locations/x/keyRings/x/cryptoKeys/x`. @@ -3075,6 +3287,23 @@ export namespace cloudkms_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$Import + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the CryptoKey to be imported into. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ImportCryptoKeyVersionRequest; + } export interface Params$Resource$Projects$Locations$Keyrings$Cryptokeys$Cryptokeyversions$List extends StandardParameters { /** @@ -3082,6 +3311,14 @@ export namespace cloudkms_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. Only include resources that match the filter in the response (https://cloud.google.com/kms/docs/sorting-and-filtering). + */ + filter?: string; + /** + * Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order (https://cloud.google.com/kms/docs/sorting-and-filtering). + */ + orderBy?: string; /** * Optional limit on the number of CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. */ @@ -3144,6 +3381,153 @@ export namespace cloudkms_v1 { this.context = context; } + /** + * cloudkms.projects.locations.keyRings.importJobs.create + * @desc Create a new ImportJob within a KeyRing. ImportJob.import_method is required. + * @alias cloudkms.projects.locations.keyRings.importJobs.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.importJobId Required. It must be unique within a KeyRing and match the regular expression `[a-zA-Z0-9_-]{1,63}` + * @param {string} params.parent Required. The name of the KeyRing associated with the ImportJobs. + * @param {().ImportJob} 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$Locations$Keyrings$Importjobs$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Keyrings$Importjobs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Keyrings$Importjobs$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Keyrings$Importjobs$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Keyrings$Importjobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Keyrings$Importjobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudkms.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/importJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * cloudkms.projects.locations.keyRings.importJobs.get + * @desc Returns metadata for a given ImportJob. + * @alias cloudkms.projects.locations.keyRings.importJobs.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the ImportJob to get. + * @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$Keyrings$Importjobs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Keyrings$Importjobs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Keyrings$Importjobs$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Keyrings$Importjobs$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Keyrings$Importjobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Keyrings$Importjobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudkms.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * cloudkms.projects.locations.keyRings.importJobs.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. @@ -3151,6 +3535,7 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3216,6 +3601,86 @@ export namespace cloudkms_v1 { } } + /** + * cloudkms.projects.locations.keyRings.importJobs.list + * @desc Lists ImportJobs. + * @alias cloudkms.projects.locations.keyRings.importJobs.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter Optional. Only include resources that match the filter in the response (https://cloud.google.com/kms/docs/sorting-and-filtering). + * @param {string=} params.orderBy Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order (https://cloud.google.com/kms/docs/sorting-and-filtering). + * @param {integer=} params.pageSize Optional limit on the number of ImportJobs to include in the response. Further ImportJobs can subsequently be obtained by including the ListImportJobsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. + * @param {string=} params.pageToken Optional pagination token, returned earlier via ListImportJobsResponse.next_page_token. + * @param {string} params.parent Required. The resource name of the KeyRing to list, in the format `projects/x/locations/x/keyRings/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 + */ + list( + params?: Params$Resource$Projects$Locations$Keyrings$Importjobs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Keyrings$Importjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Keyrings$Importjobs$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Keyrings$Importjobs$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Keyrings$Importjobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Keyrings$Importjobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudkms.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/importJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * cloudkms.projects.locations.keyRings.importJobs.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces any existing policy. @@ -3372,6 +3837,39 @@ export namespace cloudkms_v1 { } } + export interface Params$Resource$Projects$Locations$Keyrings$Importjobs$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. It must be unique within a KeyRing and match the regular expression `[a-zA-Z0-9_-]{1,63}` + */ + importJobId?: string; + /** + * Required. The name of the KeyRing associated with the ImportJobs. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ImportJob; + } + export interface Params$Resource$Projects$Locations$Keyrings$Importjobs$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the ImportJob to get. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Keyrings$Importjobs$Getiampolicy extends StandardParameters { /** @@ -3379,11 +3877,43 @@ export namespace cloudkms_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ resource?: string; } + export interface Params$Resource$Projects$Locations$Keyrings$Importjobs$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. Only include resources that match the filter in the response (https://cloud.google.com/kms/docs/sorting-and-filtering). + */ + filter?: string; + /** + * Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order (https://cloud.google.com/kms/docs/sorting-and-filtering). + */ + orderBy?: string; + /** + * Optional limit on the number of ImportJobs to include in the response. Further ImportJobs can subsequently be obtained by including the ListImportJobsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional pagination token, returned earlier via ListImportJobsResponse.next_page_token. + */ + pageToken?: string; + /** + * Required. The resource name of the KeyRing to list, in the format `projects/x/locations/x/keyRings/x`. + */ + parent?: string; + } export interface Params$Resource$Projects$Locations$Keyrings$Importjobs$Setiampolicy extends StandardParameters { /** diff --git a/src/apis/cloudkms/webpack.config.js b/src/apis/cloudkms/webpack.config.js index 255eb0ad6d5..6f7909cac18 100644 --- a/src/apis/cloudkms/webpack.config.js +++ b/src/apis/cloudkms/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/cloudprivatecatalog/package.json b/src/apis/cloudprivatecatalog/package.json index 26e21c0df5a..627ff30c01b 100644 --- a/src/apis/cloudprivatecatalog/package.json +++ b/src/apis/cloudprivatecatalog/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/cloudprivatecatalog/webpack.config.js b/src/apis/cloudprivatecatalog/webpack.config.js index 29b4e838cdf..d51fd37e981 100644 --- a/src/apis/cloudprivatecatalog/webpack.config.js +++ b/src/apis/cloudprivatecatalog/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/cloudprivatecatalogproducer/package.json b/src/apis/cloudprivatecatalogproducer/package.json index 9adc285ecd3..3171bdd1deb 100644 --- a/src/apis/cloudprivatecatalogproducer/package.json +++ b/src/apis/cloudprivatecatalogproducer/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/cloudprivatecatalogproducer/v1beta1.ts b/src/apis/cloudprivatecatalogproducer/v1beta1.ts index 37f0525c4dc..990e75c3f98 100644 --- a/src/apis/cloudprivatecatalogproducer/v1beta1.ts +++ b/src/apis/cloudprivatecatalogproducer/v1beta1.ts @@ -283,7 +283,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { updateTime?: string; } /** - * 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. + * 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:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. */ export interface Schema$GoogleIamV1AuditConfig { /** @@ -296,13 +296,17 @@ export namespace cloudprivatecatalogproducer_v1beta1 { 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. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. */ export interface Schema$GoogleIamV1AuditLogConfig { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; + /** + * Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored. + */ + ignoreChildExemptions?: boolean; /** * The log type that this config enables. */ @@ -317,7 +321,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ condition?: Schema$GoogleTypeExpr; /** - * 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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * 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@example.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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** @@ -338,7 +342,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ bindings?: Schema$GoogleIamV1Binding[]; /** - * `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` 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. */ etag?: string; /** @@ -411,7 +415,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -424,7 +428,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ export interface Schema$GoogleProtobufEmpty {} /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$GoogleRpcStatus { /** @@ -751,6 +755,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1339,6 +1344,10 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ diff --git a/src/apis/cloudprivatecatalogproducer/webpack.config.js b/src/apis/cloudprivatecatalogproducer/webpack.config.js index 129635ded04..526ff12f84c 100644 --- a/src/apis/cloudprivatecatalogproducer/webpack.config.js +++ b/src/apis/cloudprivatecatalogproducer/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/cloudprofiler/package.json b/src/apis/cloudprofiler/package.json index d50655c4c4a..7bd401353f8 100644 --- a/src/apis/cloudprofiler/package.json +++ b/src/apis/cloudprofiler/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/cloudprofiler/webpack.config.js b/src/apis/cloudprofiler/webpack.config.js index 0cb7214da8a..c6273e24686 100644 --- a/src/apis/cloudprofiler/webpack.config.js +++ b/src/apis/cloudprofiler/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/cloudresourcemanager/package.json b/src/apis/cloudresourcemanager/package.json index 1e1ef2e9448..ed4708b375f 100644 --- a/src/apis/cloudresourcemanager/package.json +++ b/src/apis/cloudresourcemanager/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/cloudresourcemanager/v1.ts b/src/apis/cloudresourcemanager/v1.ts index 5697c79ba87..d49265c8029 100644 --- a/src/apis/cloudresourcemanager/v1.ts +++ b/src/apis/cloudresourcemanager/v1.ts @@ -135,7 +135,7 @@ export namespace cloudresourcemanager_v1 { resourceId?: Schema$ResourceId; } /** - * 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. + * 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:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -148,7 +148,7 @@ export namespace cloudresourcemanager_v1 { 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. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** @@ -169,7 +169,7 @@ export namespace cloudresourcemanager_v1 { */ 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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * 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@example.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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** @@ -316,7 +316,12 @@ export namespace cloudresourcemanager_v1 { /** * Request message for `GetIamPolicy` method. */ - export interface Schema$GetIamPolicyRequest {} + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + */ + options?: Schema$GetPolicyOptions; + } /** * The request sent to the GetOrgPolicy method. */ @@ -326,6 +331,15 @@ export namespace cloudresourcemanager_v1 { */ constraint?: string; } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + requestedPolicyVersion?: number; + } /** * A Lien represents an encumbrance on the actions that can be performed on a resource. */ @@ -488,7 +502,7 @@ export namespace cloudresourcemanager_v1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -576,7 +590,7 @@ export namespace cloudresourcemanager_v1 { */ 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` 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. */ etag?: string; /** @@ -656,7 +670,7 @@ export namespace cloudresourcemanager_v1 { */ export interface Schema$SearchOrganizationsRequest { /** - * An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: | Filter | Description | |-------------------------------------|----------------------------------| | owner.directorycustomerid:123456789 | Organizations with `owner.directory_customer_id` equal to `123456789`.| | domain:google.com | Organizations corresponding to the domain `google.com`.| This field is optional. + * An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Filter `owner.directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Filter `domain:google.com` returns Organization resources corresponding to the domain `google.com`. This field is optional. */ filter?: string; /** @@ -704,7 +718,7 @@ export namespace cloudresourcemanager_v1 { policy?: Schema$OrgPolicy; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -755,7 +769,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -767,7 +781,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -791,16 +805,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.folders.clearOrgPolicy @@ -880,7 +890,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -892,7 +902,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -919,16 +929,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.folders.getEffectiveOrgPolicy @@ -1012,7 +1018,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -1024,7 +1030,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -1051,16 +1057,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.folders.getOrgPolicy @@ -1142,7 +1144,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -1154,7 +1156,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -1194,16 +1196,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.folders.listAvailableOrgPolicyConstraints @@ -1307,7 +1305,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -1319,7 +1317,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -1359,16 +1357,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.folders.listOrgPolicies @@ -1454,7 +1448,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -1466,7 +1460,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -1493,16 +1487,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.folders.setOrgPolicy @@ -1694,7 +1684,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -1706,7 +1696,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -1730,16 +1720,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.liens.create @@ -1814,7 +1800,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -1826,7 +1812,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -1846,16 +1832,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.liens.delete @@ -1927,6 +1909,52 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.liens.get * @desc Retrieve a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission requires permission `resourcemanager.projects.get` or `resourcemanager.projects.updateLiens`. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Resource Manager API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudresourcemanager + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudResourceManager = google.cloudresourcemanager('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name/identifier of the Lien. + * name: 'liens/my-lien', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudResourceManager.liens.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudresourcemanager.liens.get * @memberOf! () * @@ -1999,7 +2027,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -2011,7 +2039,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -2044,16 +2072,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.liens.list @@ -2192,7 +2216,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -2204,7 +2228,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -2227,16 +2251,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.operations.get @@ -2332,7 +2352,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -2344,7 +2364,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -2368,16 +2388,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.clearOrgPolicy @@ -2457,7 +2473,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -2469,12 +2485,14 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { * var request = { - * // The resource name of the Organization to fetch, e.g. "organizations/1234". + * // The resource name of the Organization to fetch. This is the organization's + * // relative path in the API, formatted as "organizations/[organizationId]". + * // For example, "organizations/1234". * name: 'organizations/my-organization', // TODO: Update placeholder value. * * auth: authClient, @@ -2492,16 +2510,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.get @@ -2579,7 +2593,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -2591,7 +2605,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -2618,16 +2632,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.getEffectiveOrgPolicy @@ -2711,7 +2721,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -2723,7 +2733,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -2751,16 +2761,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.getIamPolicy @@ -2840,7 +2846,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -2852,7 +2858,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -2879,16 +2885,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.getOrgPolicy @@ -2970,7 +2972,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -2982,7 +2984,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -3022,16 +3024,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints @@ -3135,7 +3133,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -3147,7 +3145,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -3187,16 +3185,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.listOrgPolicies @@ -3282,7 +3276,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -3294,7 +3288,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -3331,16 +3325,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.search @@ -3428,7 +3418,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -3440,7 +3430,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -3468,16 +3458,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.setIamPolicy @@ -3557,7 +3543,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -3569,7 +3555,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -3596,16 +3582,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.setOrgPolicy @@ -3687,7 +3669,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -3699,7 +3681,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -3727,16 +3709,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.testIamPermissions @@ -4010,7 +3988,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -4022,7 +4000,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -4046,16 +4024,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.clearOrgPolicy @@ -4131,11 +4105,11 @@ export namespace cloudresourcemanager_v1 { /** * cloudresourcemanager.projects.create - * @desc Request that a new Project be created. The result is an Operation which can be used to track the creation process. It is automatically deleted after a few hours, so there is no need to call DeleteOperation. Our SLO permits Project creation to take up to 30 seconds at the 90th percentile. As of 2016-08-29, we are observing 6 seconds 50th percentile latency. 95th percentile latency is around 11 seconds. We recommend polling at the 5th second with an exponential backoff. Authorization requires the Google IAM permission `resourcemanager.projects.create` on the specified parent for the new project. The parent is identified by a specified ResourceId, which must include both an ID and a type, such as organization. This method does not associate the new project with a billing account. You can set or update the billing account associated with a project using the [`projects.updateBillingInfo`] (/billing/reference/rest/v1/projects/updateBillingInfo) method. + * @desc Request that a new Project be created. The result is an Operation which can be used to track the creation process. This process usually takes a few seconds, but can sometimes take much longer. The tracking Operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. Authorization requires the Google IAM permission `resourcemanager.projects.create` on the specified parent for the new project. The parent is identified by a specified ResourceId, which must include both an ID and a type, such as organization. This method does not associate the new project with a billing account. You can set or update the billing account associated with a project using the [`projects.updateBillingInfo`] (/billing/reference/rest/v1/projects/updateBillingInfo) method. * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -4147,7 +4121,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -4171,16 +4145,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.create @@ -4257,7 +4227,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -4269,7 +4239,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -4290,16 +4260,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.delete @@ -4377,7 +4343,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -4389,7 +4355,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -4413,16 +4379,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.get @@ -4500,7 +4462,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -4512,7 +4474,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -4540,16 +4502,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.getAncestry @@ -4633,7 +4591,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -4645,7 +4603,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -4672,16 +4630,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.getEffectiveOrgPolicy @@ -4765,7 +4719,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -4777,7 +4731,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -4805,16 +4759,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.getIamPolicy @@ -4894,7 +4844,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -4906,7 +4856,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -4933,16 +4883,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.getOrgPolicy @@ -5024,7 +4970,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -5036,7 +4982,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -5069,16 +5015,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.list @@ -5159,7 +5101,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -5171,7 +5113,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -5211,16 +5153,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.listAvailableOrgPolicyConstraints @@ -5324,7 +5262,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -5336,7 +5274,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -5376,16 +5314,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.listOrgPolicies @@ -5471,7 +5405,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -5483,7 +5417,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -5511,16 +5445,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.setIamPolicy @@ -5600,7 +5530,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -5612,7 +5542,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -5639,16 +5569,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.setOrgPolicy @@ -5730,7 +5656,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -5742,7 +5668,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -5770,16 +5696,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.testIamPermissions @@ -5867,7 +5789,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -5879,7 +5801,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -5904,16 +5826,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.undelete @@ -5993,7 +5911,7 @@ export namespace cloudresourcemanager_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -6005,7 +5923,7 @@ export namespace cloudresourcemanager_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1'); * * authorize(function(authClient) { @@ -6034,16 +5952,12 @@ export namespace cloudresourcemanager_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.update diff --git a/src/apis/cloudresourcemanager/v1beta1.ts b/src/apis/cloudresourcemanager/v1beta1.ts index f96881ab22c..bb2d91af787 100644 --- a/src/apis/cloudresourcemanager/v1beta1.ts +++ b/src/apis/cloudresourcemanager/v1beta1.ts @@ -129,7 +129,7 @@ export namespace cloudresourcemanager_v1beta1 { resourceId?: Schema$ResourceId; } /** - * 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. + * 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:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -142,7 +142,7 @@ export namespace cloudresourcemanager_v1beta1 { 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. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** @@ -163,7 +163,7 @@ export namespace cloudresourcemanager_v1beta1 { */ 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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * 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@example.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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** @@ -242,7 +242,21 @@ export namespace cloudresourcemanager_v1beta1 { /** * Request message for `GetIamPolicy` method. */ - export interface Schema$GetIamPolicyRequest {} + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + */ + options?: Schema$GetPolicyOptions; + } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + requestedPolicyVersion?: number; + } /** * The response returned from the `ListOrganizations` method. */ @@ -320,7 +334,7 @@ export namespace cloudresourcemanager_v1beta1 { */ 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` 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. */ etag?: string; /** @@ -439,7 +453,7 @@ export namespace cloudresourcemanager_v1beta1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -451,12 +465,14 @@ export namespace cloudresourcemanager_v1beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1beta1'); * * authorize(function(authClient) { * var request = { - * // The resource name of the Organization to fetch, e.g. "organizations/1234". + * // The resource name of the Organization to fetch. This is the organization's + * // relative path in the API, formatted as "organizations/[organizationId]". + * // For example, "organizations/1234". * name: 'organizations/my-organization', // TODO: Update placeholder value. * * auth: authClient, @@ -474,16 +490,12 @@ export namespace cloudresourcemanager_v1beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.get @@ -562,7 +574,7 @@ export namespace cloudresourcemanager_v1beta1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -574,7 +586,7 @@ export namespace cloudresourcemanager_v1beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1beta1'); * * authorize(function(authClient) { @@ -602,16 +614,12 @@ export namespace cloudresourcemanager_v1beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.getIamPolicy @@ -691,7 +699,7 @@ export namespace cloudresourcemanager_v1beta1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -703,7 +711,7 @@ export namespace cloudresourcemanager_v1beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1beta1'); * * authorize(function(authClient) { @@ -736,23 +744,19 @@ export namespace cloudresourcemanager_v1beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: |Filter|Description| |------|-----------| |owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.| |domain:google.com|Organizations corresponding to the domain `google.com`.| This field is optional. + * @param {string=} params.filter An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Filter `owner.directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Filter `domain:google.com` returns Organization resources corresponding to the domain `google.com`. This field is optional. * @param {integer=} params.pageSize The maximum number of Organizations to return in the response. This field is optional. * @param {string=} params.pageToken A pagination token returned from a previous call to `ListOrganizations` that indicates from where listing should continue. This field is optional. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -835,7 +839,7 @@ export namespace cloudresourcemanager_v1beta1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -847,7 +851,7 @@ export namespace cloudresourcemanager_v1beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1beta1'); * * authorize(function(authClient) { @@ -875,16 +879,12 @@ export namespace cloudresourcemanager_v1beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.setIamPolicy @@ -964,7 +964,7 @@ export namespace cloudresourcemanager_v1beta1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -976,7 +976,7 @@ export namespace cloudresourcemanager_v1beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1beta1'); * * authorize(function(authClient) { @@ -1004,16 +1004,12 @@ export namespace cloudresourcemanager_v1beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.testIamPermissions @@ -1102,7 +1098,7 @@ export namespace cloudresourcemanager_v1beta1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -1114,7 +1110,7 @@ export namespace cloudresourcemanager_v1beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1beta1'); * * authorize(function(authClient) { @@ -1144,16 +1140,12 @@ export namespace cloudresourcemanager_v1beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.organizations.update @@ -1268,7 +1260,7 @@ export namespace cloudresourcemanager_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: |Filter|Description| |------|-----------| |owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.| |domain:google.com|Organizations corresponding to the domain `google.com`.| This field is optional. + * An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Filter `owner.directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Filter `domain:google.com` returns Organization resources corresponding to the domain `google.com`. This field is optional. */ filter?: string; /** @@ -1344,7 +1336,7 @@ export namespace cloudresourcemanager_v1beta1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -1356,7 +1348,7 @@ export namespace cloudresourcemanager_v1beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1beta1'); * * authorize(function(authClient) { @@ -1380,16 +1372,12 @@ export namespace cloudresourcemanager_v1beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.create @@ -1465,7 +1453,7 @@ export namespace cloudresourcemanager_v1beta1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -1477,7 +1465,7 @@ export namespace cloudresourcemanager_v1beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1beta1'); * * authorize(function(authClient) { @@ -1498,16 +1486,12 @@ export namespace cloudresourcemanager_v1beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.delete @@ -1585,7 +1569,7 @@ export namespace cloudresourcemanager_v1beta1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -1597,7 +1581,7 @@ export namespace cloudresourcemanager_v1beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1beta1'); * * authorize(function(authClient) { @@ -1621,16 +1605,12 @@ export namespace cloudresourcemanager_v1beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.get @@ -1708,7 +1688,7 @@ export namespace cloudresourcemanager_v1beta1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -1720,7 +1700,7 @@ export namespace cloudresourcemanager_v1beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1beta1'); * * authorize(function(authClient) { @@ -1748,16 +1728,12 @@ export namespace cloudresourcemanager_v1beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.getAncestry @@ -1840,7 +1816,7 @@ export namespace cloudresourcemanager_v1beta1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -1852,7 +1828,7 @@ export namespace cloudresourcemanager_v1beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1beta1'); * * authorize(function(authClient) { @@ -1880,16 +1856,12 @@ export namespace cloudresourcemanager_v1beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.getIamPolicy @@ -1968,7 +1940,7 @@ export namespace cloudresourcemanager_v1beta1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -1980,7 +1952,7 @@ export namespace cloudresourcemanager_v1beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1beta1'); * * authorize(function(authClient) { @@ -2013,16 +1985,12 @@ export namespace cloudresourcemanager_v1beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.list @@ -2103,7 +2071,7 @@ export namespace cloudresourcemanager_v1beta1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -2115,7 +2083,7 @@ export namespace cloudresourcemanager_v1beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1beta1'); * * authorize(function(authClient) { @@ -2143,16 +2111,12 @@ export namespace cloudresourcemanager_v1beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.setIamPolicy @@ -2231,7 +2195,7 @@ export namespace cloudresourcemanager_v1beta1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -2243,7 +2207,7 @@ export namespace cloudresourcemanager_v1beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1beta1'); * * authorize(function(authClient) { @@ -2271,16 +2235,12 @@ export namespace cloudresourcemanager_v1beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.testIamPermissions @@ -2368,7 +2328,7 @@ export namespace cloudresourcemanager_v1beta1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -2380,7 +2340,7 @@ export namespace cloudresourcemanager_v1beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1beta1'); * * authorize(function(authClient) { @@ -2405,16 +2365,12 @@ export namespace cloudresourcemanager_v1beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.undelete @@ -2494,7 +2450,7 @@ export namespace cloudresourcemanager_v1beta1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Resource Manager API + * // 1. If not already done, enable the Cloud Resource Manager API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/cloudresourcemanager * // 2. This sample uses Application Default Credentials for authentication. @@ -2506,7 +2462,7 @@ export namespace cloudresourcemanager_v1beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudResourceManager = google.cloudresourcemanager('v1beta1'); * * authorize(function(authClient) { @@ -2535,16 +2491,12 @@ export namespace cloudresourcemanager_v1beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudresourcemanager.projects.update diff --git a/src/apis/cloudresourcemanager/v2.ts b/src/apis/cloudresourcemanager/v2.ts index 3c448d762f7..d8ea48e4330 100644 --- a/src/apis/cloudresourcemanager/v2.ts +++ b/src/apis/cloudresourcemanager/v2.ts @@ -120,7 +120,7 @@ export namespace cloudresourcemanager_v2 { } /** - * 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. + * 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:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -133,7 +133,7 @@ export namespace cloudresourcemanager_v2 { 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. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** @@ -154,7 +154,7 @@ export namespace cloudresourcemanager_v2 { */ 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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * 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@example.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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** @@ -196,7 +196,7 @@ export namespace cloudresourcemanager_v2 { */ displayName?: string; /** - * Output only. The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder. + * Output only. The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder. */ lifecycleState?: string; /** @@ -241,7 +241,21 @@ export namespace cloudresourcemanager_v2 { /** * Request message for `GetIamPolicy` method. */ - export interface Schema$GetIamPolicyRequest {} + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + */ + options?: Schema$GetPolicyOptions; + } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + requestedPolicyVersion?: number; + } /** * The ListFolders response message. */ @@ -281,7 +295,7 @@ export namespace cloudresourcemanager_v2 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -302,7 +316,7 @@ export namespace cloudresourcemanager_v2 { */ 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` 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. */ etag?: string; /** @@ -340,7 +354,7 @@ export namespace cloudresourcemanager_v2 { */ pageToken?: string; /** - * Search criteria used to select the Folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR` 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 String\\"|Folders whose display name includes both "Test" and "String".| + * Search criteria used to select the Folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR` 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 `displayName=Test*` returns Folder resources whose display name starts with "Test". * Query `lifecycleState=ACTIVE` returns Folder resources with `lifecycleState` set to `ACTIVE`. * Query `parent=folders/123` returns Folder resources that have `folders/123` as a parent resource. * Query `parent=folders/123 AND lifecycleState=ACTIVE` returns active Folder resources that have `folders/123` as a parent resource. * Query `displayName=\\"Test String\\"` returns Folder resources with display names that include both "Test" and "String". */ query?: string; } @@ -371,7 +385,7 @@ export namespace cloudresourcemanager_v2 { updateMask?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/cloudresourcemanager/v2beta1.ts b/src/apis/cloudresourcemanager/v2beta1.ts index 48985c210e5..46de74e3260 100644 --- a/src/apis/cloudresourcemanager/v2beta1.ts +++ b/src/apis/cloudresourcemanager/v2beta1.ts @@ -120,7 +120,7 @@ export namespace cloudresourcemanager_v2beta1 { } /** - * 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. + * 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:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -133,7 +133,7 @@ export namespace cloudresourcemanager_v2beta1 { 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. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** @@ -154,7 +154,7 @@ export namespace cloudresourcemanager_v2beta1 { */ 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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * 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@example.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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** @@ -196,7 +196,7 @@ export namespace cloudresourcemanager_v2beta1 { */ displayName?: string; /** - * Output only. The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder. + * Output only. The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder. */ lifecycleState?: string; /** @@ -241,7 +241,21 @@ export namespace cloudresourcemanager_v2beta1 { /** * Request message for `GetIamPolicy` method. */ - export interface Schema$GetIamPolicyRequest {} + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + */ + options?: Schema$GetPolicyOptions; + } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + requestedPolicyVersion?: number; + } /** * The ListFolders response message. */ @@ -281,7 +295,7 @@ export namespace cloudresourcemanager_v2beta1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -302,7 +316,7 @@ export namespace cloudresourcemanager_v2beta1 { */ 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` 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. */ etag?: string; /** @@ -340,7 +354,7 @@ export namespace cloudresourcemanager_v2beta1 { */ pageToken?: string; /** - * Search criteria used to select the Folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR` 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 String\\"|Folders whose display name includes both "Test" and "String".| + * Search criteria used to select the Folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR` 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 `displayName=Test*` returns Folder resources whose display name starts with "Test". * Query `lifecycleState=ACTIVE` returns Folder resources with `lifecycleState` set to `ACTIVE`. * Query `parent=folders/123` returns Folder resources that have `folders/123` as a parent resource. * Query `parent=folders/123 AND lifecycleState=ACTIVE` returns active Folder resources that have `folders/123` as a parent resource. * Query `displayName=\\"Test String\\"` returns Folder resources with display names that include both "Test" and "String". */ query?: string; } @@ -371,7 +385,7 @@ export namespace cloudresourcemanager_v2beta1 { updateMask?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/cloudresourcemanager/webpack.config.js b/src/apis/cloudresourcemanager/webpack.config.js index 80cabf0121c..f448b52be9c 100644 --- a/src/apis/cloudresourcemanager/webpack.config.js +++ b/src/apis/cloudresourcemanager/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/cloudscheduler/package.json b/src/apis/cloudscheduler/package.json index f418453ad32..e6583aab8ae 100644 --- a/src/apis/cloudscheduler/package.json +++ b/src/apis/cloudscheduler/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/cloudscheduler/v1.ts b/src/apis/cloudscheduler/v1.ts index 9a0ad76c641..8bda17819f3 100644 --- a/src/apis/cloudscheduler/v1.ts +++ b/src/apis/cloudscheduler/v1.ts @@ -184,11 +184,11 @@ export namespace cloudscheduler_v1 { */ httpMethod?: string; /** - * If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should be used when sending requests to a GCP endpoint. + * If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. */ oauthToken?: Schema$OAuthToken; /** - * If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. + * If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. */ oidcToken?: Schema$OidcToken; /** @@ -309,7 +309,7 @@ export namespace cloudscheduler_v1 { name?: string; } /** - * Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should be used when sending requests to a GCP endpoint. + * Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. */ export interface Schema$OAuthToken { /** @@ -322,7 +322,7 @@ export namespace cloudscheduler_v1 { serviceAccountEmail?: string; } /** - * Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization should be used when sending requests to third party endpoints or Cloud Run. + * Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. */ export interface Schema$OidcToken { /** @@ -410,7 +410,7 @@ export namespace cloudscheduler_v1 { */ export interface Schema$RunJobRequest {} /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -447,6 +447,52 @@ export namespace cloudscheduler_v1 { /** * cloudscheduler.projects.locations.get * @desc Gets information about a location. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Resource name for the location. + * name: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudScheduler.projects.locations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.get * @memberOf! () * @@ -517,6 +563,65 @@ export namespace cloudscheduler_v1 { /** * cloudscheduler.projects.locations.list * @desc Lists information about the supported locations for this service. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource that owns the locations collection, if applicable. + * name: 'projects/my-project', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var locationsPage = response['locations']; + * if (!locationsPage) { + * return; + * } + * for (var i = 0; i < locationsPage.length; i++) { + * // TODO: Change code below to process each resource in `locationsPage`: + * console.log(JSON.stringify(locationsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudScheduler.projects.locations.list(request, handlePage); + * } + * }; + * + * cloudScheduler.projects.locations.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.list * @memberOf! () * @@ -641,6 +746,58 @@ export namespace cloudscheduler_v1 { /** * cloudscheduler.projects.locations.jobs.create * @desc Creates a job. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The location name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID`. + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudScheduler.projects.locations.jobs.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.jobs.create * @memberOf! () * @@ -712,6 +869,51 @@ export namespace cloudscheduler_v1 { /** * cloudscheduler.projects.locations.jobs.delete * @desc Deletes a job. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The job name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * name: 'projects/my-project/locations/my-location/jobs/my-job', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudScheduler.projects.locations.jobs.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.jobs.delete * @memberOf! () * @@ -782,6 +984,54 @@ export namespace cloudscheduler_v1 { /** * cloudscheduler.projects.locations.jobs.get * @desc Gets a job. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The job name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * name: 'projects/my-project/locations/my-location/jobs/my-job', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudScheduler.projects.locations.jobs.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.jobs.get * @memberOf! () * @@ -852,6 +1102,67 @@ export namespace cloudscheduler_v1 { /** * cloudscheduler.projects.locations.jobs.list * @desc Lists jobs. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The location name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID`. + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var jobsPage = response['jobs']; + * if (!jobsPage) { + * return; + * } + * for (var i = 0; i < jobsPage.length; i++) { + * // TODO: Change code below to process each resource in `jobsPage`: + * console.log(JSON.stringify(jobsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudScheduler.projects.locations.jobs.list(request, handlePage); + * } + * }; + * + * cloudScheduler.projects.locations.jobs.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.jobs.list * @memberOf! () * @@ -926,6 +1237,72 @@ export namespace cloudscheduler_v1 { /** * cloudscheduler.projects.locations.jobs.patch * @desc Updates a job. If successful, the updated Job is returned. If the job does not exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Optionally caller-specified in CreateJob, after + * // which it becomes output only. + * // The job name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * // * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), + * // hyphens (-), colons (:), or periods (.). + * // For more information, see + * // [Identifying + * // projects] + * // (https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) + * // * `LOCATION_ID` is the canonical ID for the job's location. + * // The list of available locations can be obtained by calling + * // ListLocations. + * // For more information, see https://cloud.google.com/about/locations/. + * // * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), + * // hyphens (-), or underscores (_). The maximum length is 500 characters. + * name: 'projects/my-project/locations/my-location/jobs/my-job', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * cloudScheduler.projects.locations.jobs.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.jobs.patch * @memberOf! () * @@ -998,6 +1375,58 @@ export namespace cloudscheduler_v1 { /** * cloudscheduler.projects.locations.jobs.pause * @desc Pauses a job. If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The job name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * name: 'projects/my-project/locations/my-location/jobs/my-job', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudScheduler.projects.locations.jobs.pause(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.jobs.pause * @memberOf! () * @@ -1069,6 +1498,58 @@ export namespace cloudscheduler_v1 { /** * cloudscheduler.projects.locations.jobs.resume * @desc Resume a job. This method reenables a job after it has been Job.State.PAUSED. The state of a job is stored in Job.state; after calling this method it will be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The job name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * name: 'projects/my-project/locations/my-location/jobs/my-job', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudScheduler.projects.locations.jobs.resume(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.jobs.resume * @memberOf! () * @@ -1140,6 +1621,58 @@ export namespace cloudscheduler_v1 { /** * cloudscheduler.projects.locations.jobs.run * @desc Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The job name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * name: 'projects/my-project/locations/my-location/jobs/my-job', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudScheduler.projects.locations.jobs.run(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.jobs.run * @memberOf! () * diff --git a/src/apis/cloudscheduler/v1beta1.ts b/src/apis/cloudscheduler/v1beta1.ts index 4b1d9da93c7..c036175e7bd 100644 --- a/src/apis/cloudscheduler/v1beta1.ts +++ b/src/apis/cloudscheduler/v1beta1.ts @@ -184,11 +184,11 @@ export namespace cloudscheduler_v1beta1 { */ httpMethod?: string; /** - * If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should be used when sending requests to a GCP endpoint. + * If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. */ oauthToken?: Schema$OAuthToken; /** - * If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. + * If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. */ oidcToken?: Schema$OidcToken; /** @@ -309,7 +309,7 @@ export namespace cloudscheduler_v1beta1 { name?: string; } /** - * Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should be used when sending requests to a GCP endpoint. + * Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. */ export interface Schema$OAuthToken { /** @@ -322,7 +322,7 @@ export namespace cloudscheduler_v1beta1 { serviceAccountEmail?: string; } /** - * Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization should be used when sending requests to third party endpoints or Cloud Run. + * Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. */ export interface Schema$OidcToken { /** @@ -410,7 +410,7 @@ export namespace cloudscheduler_v1beta1 { */ export interface Schema$RunJobRequest {} /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -447,6 +447,52 @@ export namespace cloudscheduler_v1beta1 { /** * cloudscheduler.projects.locations.get * @desc Gets information about a location. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Resource name for the location. + * name: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudScheduler.projects.locations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.get * @memberOf! () * @@ -517,6 +563,65 @@ export namespace cloudscheduler_v1beta1 { /** * cloudscheduler.projects.locations.list * @desc Lists information about the supported locations for this service. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource that owns the locations collection, if applicable. + * name: 'projects/my-project', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var locationsPage = response['locations']; + * if (!locationsPage) { + * return; + * } + * for (var i = 0; i < locationsPage.length; i++) { + * // TODO: Change code below to process each resource in `locationsPage`: + * console.log(JSON.stringify(locationsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudScheduler.projects.locations.list(request, handlePage); + * } + * }; + * + * cloudScheduler.projects.locations.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.list * @memberOf! () * @@ -641,6 +746,58 @@ export namespace cloudscheduler_v1beta1 { /** * cloudscheduler.projects.locations.jobs.create * @desc Creates a job. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The location name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID`. + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudScheduler.projects.locations.jobs.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.jobs.create * @memberOf! () * @@ -715,6 +872,51 @@ export namespace cloudscheduler_v1beta1 { /** * cloudscheduler.projects.locations.jobs.delete * @desc Deletes a job. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The job name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * name: 'projects/my-project/locations/my-location/jobs/my-job', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudScheduler.projects.locations.jobs.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.jobs.delete * @memberOf! () * @@ -785,6 +987,54 @@ export namespace cloudscheduler_v1beta1 { /** * cloudscheduler.projects.locations.jobs.get * @desc Gets a job. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The job name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * name: 'projects/my-project/locations/my-location/jobs/my-job', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudScheduler.projects.locations.jobs.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.jobs.get * @memberOf! () * @@ -855,6 +1105,67 @@ export namespace cloudscheduler_v1beta1 { /** * cloudscheduler.projects.locations.jobs.list * @desc Lists jobs. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The location name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID`. + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var jobsPage = response['jobs']; + * if (!jobsPage) { + * return; + * } + * for (var i = 0; i < jobsPage.length; i++) { + * // TODO: Change code below to process each resource in `jobsPage`: + * console.log(JSON.stringify(jobsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudScheduler.projects.locations.jobs.list(request, handlePage); + * } + * }; + * + * cloudScheduler.projects.locations.jobs.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.jobs.list * @memberOf! () * @@ -932,6 +1243,72 @@ export namespace cloudscheduler_v1beta1 { /** * cloudscheduler.projects.locations.jobs.patch * @desc Updates a job. If successful, the updated Job is returned. If the job does not exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Optionally caller-specified in CreateJob, after + * // which it becomes output only. + * // The job name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * // * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), + * // hyphens (-), colons (:), or periods (.). + * // For more information, see + * // [Identifying + * // projects] + * // (https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) + * // * `LOCATION_ID` is the canonical ID for the job's location. + * // The list of available locations can be obtained by calling + * // ListLocations. + * // For more information, see https://cloud.google.com/about/locations/. + * // * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), + * // hyphens (-), or underscores (_). The maximum length is 500 characters. + * name: 'projects/my-project/locations/my-location/jobs/my-job', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * cloudScheduler.projects.locations.jobs.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.jobs.patch * @memberOf! () * @@ -1004,6 +1381,58 @@ export namespace cloudscheduler_v1beta1 { /** * cloudscheduler.projects.locations.jobs.pause * @desc Pauses a job. If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The job name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * name: 'projects/my-project/locations/my-location/jobs/my-job', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudScheduler.projects.locations.jobs.pause(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.jobs.pause * @memberOf! () * @@ -1078,6 +1507,58 @@ export namespace cloudscheduler_v1beta1 { /** * cloudscheduler.projects.locations.jobs.resume * @desc Resume a job. This method reenables a job after it has been Job.State.PAUSED. The state of a job is stored in Job.state; after calling this method it will be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The job name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * name: 'projects/my-project/locations/my-location/jobs/my-job', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudScheduler.projects.locations.jobs.resume(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.jobs.resume * @memberOf! () * @@ -1152,6 +1633,58 @@ export namespace cloudscheduler_v1beta1 { /** * cloudscheduler.projects.locations.jobs.run * @desc Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Scheduler API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudscheduler + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudScheduler = google.cloudscheduler('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The job name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * name: 'projects/my-project/locations/my-location/jobs/my-job', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudScheduler.projects.locations.jobs.run(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudscheduler.projects.locations.jobs.run * @memberOf! () * diff --git a/src/apis/cloudscheduler/webpack.config.js b/src/apis/cloudscheduler/webpack.config.js index e2a9af5186e..1f9f5a895ba 100644 --- a/src/apis/cloudscheduler/webpack.config.js +++ b/src/apis/cloudscheduler/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/cloudsearch/package.json b/src/apis/cloudsearch/package.json index fa91b1df823..3ad03df54a1 100644 --- a/src/apis/cloudsearch/package.json +++ b/src/apis/cloudsearch/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/cloudsearch/v1.ts b/src/apis/cloudsearch/v1.ts index fd48e2add9c..2d011768030 100644 --- a/src/apis/cloudsearch/v1.ts +++ b/src/apis/cloudsearch/v1.ts @@ -1240,6 +1240,10 @@ export namespace cloudsearch_v1 { * Indicates that the property can be used for sorting. Cannot be true for properties that are repeatable. Cannot be true for properties whose type is object or user identifier. IsReturnable must be true to set this option. Only supported for Boolean, Date, Double, Integer, and Timestamp properties. */ isSortable?: boolean; + /** + * Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. Note: This is an alpha feature and is enabled for whitelisted users only. + */ + isWildcardSearchable?: boolean; /** * The name of the property. Item indexing requests sent to the Indexing API should set the property name equal to this value. For example, if name is *subject_line*, then indexing requests for document items with subject fields should set the name for that field equal to *subject_line*. Use the name as the identifier for the object property. Once registered as a property for an object, you cannot re-use this name for another property within that object. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters. */ @@ -1869,7 +1873,7 @@ export namespace cloudsearch_v1 { debugOptions?: Schema$DebugOptions; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/cloudsearch/webpack.config.js b/src/apis/cloudsearch/webpack.config.js index e74bf7b0f29..737e28ce04b 100644 --- a/src/apis/cloudsearch/webpack.config.js +++ b/src/apis/cloudsearch/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/cloudshell/package.json b/src/apis/cloudshell/package.json index e1da1156d53..91cb1ecb754 100644 --- a/src/apis/cloudshell/package.json +++ b/src/apis/cloudshell/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/cloudshell/v1.ts b/src/apis/cloudshell/v1.ts index e596e2e35ea..cd0f934a4d3 100644 --- a/src/apis/cloudshell/v1.ts +++ b/src/apis/cloudshell/v1.ts @@ -236,7 +236,7 @@ export namespace cloudshell_v1 { environment?: Schema$Environment; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/cloudshell/v1alpha1.ts b/src/apis/cloudshell/v1alpha1.ts index 4da25df9fff..aaaf6112350 100644 --- a/src/apis/cloudshell/v1alpha1.ts +++ b/src/apis/cloudshell/v1alpha1.ts @@ -254,7 +254,7 @@ export namespace cloudshell_v1alpha1 { environment?: Schema$Environment; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/cloudshell/webpack.config.js b/src/apis/cloudshell/webpack.config.js index be8f8a63f4e..41c8db5231c 100644 --- a/src/apis/cloudshell/webpack.config.js +++ b/src/apis/cloudshell/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/cloudtasks/package.json b/src/apis/cloudtasks/package.json index 0c90abeb345..3526d75c601 100644 --- a/src/apis/cloudtasks/package.json +++ b/src/apis/cloudtasks/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/cloudtasks/v2.ts b/src/apis/cloudtasks/v2.ts index 1f58b15d62f..5657d7426a2 100644 --- a/src/apis/cloudtasks/v2.ts +++ b/src/apis/cloudtasks/v2.ts @@ -118,7 +118,7 @@ export namespace cloudtasks_v2 { } /** - * App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_queue set. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. `503` is considered an App Engine system error instead of an application error. Requests returning error `503` will be retried regardless of retry configuration and not counted against retry counts. Any other response code or a failure to receive a response before the deadline is a failed attempt. + * App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. */ export interface Schema$AppEngineHttpRequest { /** @@ -426,7 +426,7 @@ export namespace cloudtasks_v2 { policy?: Schema$Policy; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -526,6 +526,52 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.get * @desc Gets information about a location. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Resource name for the location. + * name: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.get * @memberOf! () * @@ -595,6 +641,65 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.list * @desc Lists information about the supported locations for this service. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // The resource that owns the locations collection, if applicable. + * name: 'projects/my-project', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var locationsPage = response['locations']; + * if (!locationsPage) { + * return; + * } + * for (var i = 0; i < locationsPage.length; i++) { + * // TODO: Change code below to process each resource in `locationsPage`: + * console.log(JSON.stringify(locationsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudTasks.projects.locations.list(request, handlePage); + * } + * }; + * + * cloudTasks.projects.locations.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.list * @memberOf! () * @@ -720,6 +825,61 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.create * @desc Creates a queue. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The location name in which the queue will be created. + * // For example: `projects/PROJECT_ID/locations/LOCATION_ID` + * // The list of allowed locations can be obtained by calling Cloud + * // Tasks' implementation of + * // ListLocations. + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.create * @memberOf! () * @@ -793,6 +953,51 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.delete * @desc Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name can't be created for 7 days. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The queue name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.delete * @memberOf! () * @@ -862,6 +1067,54 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.get * @desc Gets a queue. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The resource name of the queue. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.get * @memberOf! () * @@ -931,6 +1184,57 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.getIamPolicy * @desc Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.getIamPolicy` + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.getIamPolicy * @memberOf! () * @@ -1004,6 +1308,67 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.list * @desc Lists queues. Queues are returned in lexicographical order. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The location name. + * // For example: `projects/PROJECT_ID/locations/LOCATION_ID` + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var queuesPage = response['queues']; + * if (!queuesPage) { + * return; + * } + * for (var i = 0; i < queuesPage.length; i++) { + * // TODO: Change code below to process each resource in `queuesPage`: + * console.log(JSON.stringify(queuesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudTasks.projects.locations.queues.list(request, handlePage); + * } + * }; + * + * cloudTasks.projects.locations.queues.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.list * @memberOf! () * @@ -1081,6 +1446,73 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.patch * @desc Updates a queue. This method creates the queue if it does not exist and updates the queue if it does exist. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // 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] + * // (https://cloud.google.com/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. + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.patch * @memberOf! () * @@ -1152,6 +1584,58 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.pause * @desc Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The queue name. For example: + * // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.pause(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.pause * @memberOf! () * @@ -1222,6 +1706,58 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.purge * @desc Purges a queue by deleting all of its tasks. All tasks created before this method is called are permanently deleted. Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The queue name. For example: + * // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.purge(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.purge * @memberOf! () * @@ -1292,6 +1828,58 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.resume * @desc Resume a queue. This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to RUNNING. WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling). + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The queue name. For example: + * // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.resume(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.resume * @memberOf! () * @@ -1362,6 +1950,57 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.setIamPolicy * @desc Sets the access control policy for a Queue. Replaces any existing policy. Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required to use the Cloud Console. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.setIamPolicy` + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.setIamPolicy * @memberOf! () * @@ -1435,6 +2074,57 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.testIamPermissions * @desc Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.testIamPermissions * @memberOf! () * @@ -1712,7 +2402,60 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.tasks.create - * @desc Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * For App Engine queues, the maximum task size is 100KB. + * @desc Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * The maximum task size is 100KB. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The queue name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * // The queue must already exist. + * parent: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.tasks.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.tasks.create * @memberOf! () * @@ -1786,6 +2529,51 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.tasks.delete * @desc Deletes a task. A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has executed successfully or permanently failed. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The task name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.tasks.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.tasks.delete * @memberOf! () * @@ -1855,6 +2643,54 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.tasks.get * @desc Gets a task. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The task name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.tasks.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.tasks.get * @memberOf! () * @@ -1925,11 +2761,72 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.tasks.list * @desc Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The queue name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * parent: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var tasksPage = response['tasks']; + * if (!tasksPage) { + * return; + * } + * for (var i = 0; i < tasksPage.length; i++) { + * // TODO: Change code below to process each resource in `tasksPage`: + * console.log(JSON.stringify(tasksPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudTasks.projects.locations.queues.tasks.list(request, handlePage); + * } + * }; + * + * cloudTasks.projects.locations.queues.tasks.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.tasks.list * @memberOf! () * * @param {object} params Parameters for request - * @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 {integer=} params.pageSize Maximum page size. 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. The maximum page size is 1000. If unspecified, the page size will be the maximum. * @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` * @param {string=} params.responseView The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. @@ -2002,6 +2899,58 @@ export namespace cloudtasks_v2 { /** * cloudtasks.projects.locations.queues.tasks.run * @desc Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED. This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now. The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target. If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The task name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.tasks.run(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.tasks.run * @memberOf! () * @@ -2123,7 +3072,7 @@ export namespace cloudtasks_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * 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. + * Maximum page size. 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. The maximum page size is 1000. If unspecified, the page size will be the maximum. */ pageSize?: number; /** diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index ca6a5c54fd0..8d1a32789ad 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -127,7 +127,7 @@ export namespace cloudtasks_v2beta2 { scheduleTime?: string; } /** - * App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_target set. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_url Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. `503` is considered an App Engine system error instead of an application error. Requests returning error `503` will be retried regardless of retry configuration and not counted against retry counts. Any other response code or a failure to receive a response before the deadline is a failed attempt. + * App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_target set. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_url Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. */ export interface Schema$AppEngineHttpRequest { /** @@ -283,7 +283,7 @@ export namespace cloudtasks_v2beta2 { */ filter?: string; /** - * After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later LeaseTasks call so that another worker can retry it. The maximum lease duration is 1 week. `lease_duration` will be truncated to the nearest second. + * Required. The duration of the lease. Each task returned in the response will have its schedule_time set to the current time plus the `lease_duration`. The task is leased until its schedule_time; thus, the task will not be returned to another LeaseTasks call before its schedule_time. After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later LeaseTasks call so that another worker can retry it. The maximum lease duration is 1 week. `lease_duration` will be truncated to the nearest second. */ leaseDuration?: string; /** @@ -529,7 +529,7 @@ export namespace cloudtasks_v2beta2 { policy?: Schema$Policy; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -3340,7 +3340,7 @@ export namespace cloudtasks_v2beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @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 {integer=} params.pageSize Maximum page size. 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. The maximum page size is 1000. If unspecified, the page size will be the maximum. * @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` * @param {string=} params.responseView The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. @@ -3773,7 +3773,7 @@ export namespace cloudtasks_v2beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * 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. + * Maximum page size. 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. The maximum page size is 1000. If unspecified, the page size will be the maximum. */ pageSize?: number; /** diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index 46a9b67c942..fdf0e3cd68e 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -127,7 +127,7 @@ export namespace cloudtasks_v2beta3 { appEngineRoutingOverride?: Schema$AppEngineRouting; } /** - * App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_queue set. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. `503` is considered an App Engine system error instead of an application error. Requests returning error `503` will be retried regardless of retry configuration and not counted against retry counts. Any other response code or a failure to receive a response before the deadline is a failed attempt. + * App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. */ export interface Schema$AppEngineHttpRequest { /** @@ -252,6 +252,35 @@ export namespace cloudtasks_v2beta3 { * Request message for `GetIamPolicy` method. */ export interface Schema$GetIamPolicyRequest {} + /** + * HTTP request. The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([`200` - `299`]), the task will removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following: * User-specified throttling: retry configuration, rate limits, and the queue's state. * System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed. System throttling happens because: * Cloud Tasks backoffs on all errors. Normally the backoff specified in rate limits will be used. But if the worker returns `429` (Too Many Requests), `503` (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the `Retry-After` HTTP response header is considered. * To prevent traffic spikes and to smooth sudden large traffic spikes, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time). + */ + export interface Schema$HttpRequest { + /** + * HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. + */ + body?: string; + /** + * HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * X-Google-*: Google use only. * X-AppEngine-*: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. + */ + headers?: {[key: string]: string}; + /** + * The HTTP method to use for the request. The default is POST. + */ + httpMethod?: string; + /** + * If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + */ + oauthToken?: Schema$OAuthToken; + /** + * If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + */ + oidcToken?: Schema$OidcToken; + /** + * Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt. + */ + url?: string; + } /** * The response message for Locations.ListLocations. */ @@ -316,6 +345,32 @@ export namespace cloudtasks_v2beta3 { */ name?: string; } + /** + * Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + */ + export interface Schema$OAuthToken { + /** + * OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + */ + scope?: string; + /** + * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + */ + serviceAccountEmail?: string; + } + /** + * Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + */ + export interface Schema$OidcToken { + /** + * Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + */ + audience?: string; + /** + * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + */ + serviceAccountEmail?: string; + } /** * Request message for PauseQueue. */ @@ -346,7 +401,7 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$Queue { /** - * AppEngineHttpQueue settings apply only to App Engine tasks in this queue. + * AppEngineHttpQueue settings apply only to App Engine tasks in this queue. Http tasks are not affected by this proto. */ appEngineHttpQueue?: Schema$AppEngineHttpQueue; /** @@ -365,6 +420,10 @@ export namespace cloudtasks_v2beta3 { * Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). */ retryConfig?: Schema$RetryConfig; + /** + * Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. + */ + stackdriverLoggingConfig?: Schema$StackdriverLoggingConfig; /** * Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`. */ @@ -435,7 +494,16 @@ export namespace cloudtasks_v2beta3 { policy?: Schema$Policy; } /** - * 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. + * Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). + */ + export interface Schema$StackdriverLoggingConfig { + /** + * Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. + */ + samplingRatio?: number; + } + /** + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -468,13 +536,17 @@ export namespace cloudtasks_v2beta3 { */ dispatchCount?: number; /** - * The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listing for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the [scaling type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling) of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's `dispatch_deadline`, the app handler will not run for longer than than the service's timeout. We recommend setting the `dispatch_deadline` to at most a few seconds more than the app handler's timeout. For more information see [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts). `dispatch_deadline` will be truncated to the nearest millisecond. The deadline is an approximate deadline. + * The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listing for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the [scaling type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling) of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's `dispatch_deadline`, the app handler will not run for longer than than the service's timeout. We recommend setting the `dispatch_deadline` to at most a few seconds more than the app handler's timeout. For more information see [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts). `dispatch_deadline` will be truncated to the nearest millisecond. The deadline is an approximate deadline. */ dispatchDeadline?: string; /** * Output only. The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks. */ firstAttempt?: Schema$Attempt; + /** + * HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set. + */ + httpRequest?: Schema$HttpRequest; /** * Output only. The status of the task's last attempt. */ @@ -535,6 +607,52 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.get * @desc Gets information about a location. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // Resource name for the location. + * name: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.get * @memberOf! () * @@ -604,6 +722,65 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.list * @desc Lists information about the supported locations for this service. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // The resource that owns the locations collection, if applicable. + * name: 'projects/my-project', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var locationsPage = response['locations']; + * if (!locationsPage) { + * return; + * } + * for (var i = 0; i < locationsPage.length; i++) { + * // TODO: Change code below to process each resource in `locationsPage`: + * console.log(JSON.stringify(locationsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudTasks.projects.locations.list(request, handlePage); + * } + * }; + * + * cloudTasks.projects.locations.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.list * @memberOf! () * @@ -729,6 +906,61 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.create * @desc Creates a queue. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The location name in which the queue will be created. + * // For example: `projects/PROJECT_ID/locations/LOCATION_ID` + * // The list of allowed locations can be obtained by calling Cloud + * // Tasks' implementation of + * // ListLocations. + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.create * @memberOf! () * @@ -802,6 +1034,51 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.delete * @desc Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name can't be created for 7 days. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The queue name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.delete * @memberOf! () * @@ -871,6 +1148,54 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.get * @desc Gets a queue. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The resource name of the queue. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.get * @memberOf! () * @@ -940,6 +1265,57 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.getIamPolicy * @desc Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.getIamPolicy` + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.getIamPolicy * @memberOf! () * @@ -1013,6 +1389,67 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.list * @desc Lists queues. Queues are returned in lexicographical order. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The location name. + * // For example: `projects/PROJECT_ID/locations/LOCATION_ID` + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var queuesPage = response['queues']; + * if (!queuesPage) { + * return; + * } + * for (var i = 0; i < queuesPage.length; i++) { + * // TODO: Change code below to process each resource in `queuesPage`: + * console.log(JSON.stringify(queuesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudTasks.projects.locations.queues.list(request, handlePage); + * } + * }; + * + * cloudTasks.projects.locations.queues.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.list * @memberOf! () * @@ -1090,6 +1527,73 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.patch * @desc Updates a queue. This method creates the queue if it does not exist and updates the queue if it does exist. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // 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] + * // (https://cloud.google.com/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. + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.patch * @memberOf! () * @@ -1161,6 +1665,58 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.pause * @desc Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The queue name. For example: + * // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.pause(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.pause * @memberOf! () * @@ -1234,6 +1790,58 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.purge * @desc Purges a queue by deleting all of its tasks. All tasks created before this method is called are permanently deleted. Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The queue name. For example: + * // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.purge(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.purge * @memberOf! () * @@ -1307,6 +1915,58 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.resume * @desc Resume a queue. This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to RUNNING. WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling). + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The queue name. For example: + * // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.resume(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.resume * @memberOf! () * @@ -1380,6 +2040,57 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.setIamPolicy * @desc Sets the access control policy for a Queue. Replaces any existing policy. Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required to use the Cloud Console. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.setIamPolicy` + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.setIamPolicy * @memberOf! () * @@ -1453,6 +2164,57 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.testIamPermissions * @desc Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.testIamPermissions * @memberOf! () * @@ -1730,7 +2492,60 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.tasks.create - * @desc Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * For App Engine queues, the maximum task size is 100KB. + * @desc Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * The maximum task size is 100KB. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The queue name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * // The queue must already exist. + * parent: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.tasks.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.tasks.create * @memberOf! () * @@ -1804,6 +2619,51 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.tasks.delete * @desc Deletes a task. A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has executed successfully or permanently failed. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The task name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.tasks.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.tasks.delete * @memberOf! () * @@ -1873,6 +2733,54 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.tasks.get * @desc Gets a task. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The task name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.tasks.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.tasks.get * @memberOf! () * @@ -1943,11 +2851,72 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.tasks.list * @desc Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The queue name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + * parent: 'projects/my-project/locations/my-location/queues/my-queue', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var tasksPage = response['tasks']; + * if (!tasksPage) { + * return; + * } + * for (var i = 0; i < tasksPage.length; i++) { + * // TODO: Change code below to process each resource in `tasksPage`: + * console.log(JSON.stringify(tasksPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudTasks.projects.locations.queues.tasks.list(request, handlePage); + * } + * }; + * + * cloudTasks.projects.locations.queues.tasks.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.tasks.list * @memberOf! () * * @param {object} params Parameters for request - * @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 {integer=} params.pageSize Maximum page size. 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. The maximum page size is 1000. If unspecified, the page size will be the maximum. * @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` * @param {string=} params.responseView The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. @@ -2020,6 +2989,58 @@ export namespace cloudtasks_v2beta3 { /** * cloudtasks.projects.locations.queues.tasks.run * @desc Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED. This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now. The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target. If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Tasks API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/cloudtasks + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudTasks = google.cloudtasks('v2beta3'); + * + * authorize(function(authClient) { + * var request = { + * // Required. + * // The task name. For example: + * // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + * name: 'projects/my-project/locations/my-location/queues/my-queue/tasks/my-task', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudTasks.projects.locations.queues.tasks.run(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias cloudtasks.projects.locations.queues.tasks.run * @memberOf! () * @@ -2144,7 +3165,7 @@ export namespace cloudtasks_v2beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * 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. + * Maximum page size. 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. The maximum page size is 1000. If unspecified, the page size will be the maximum. */ pageSize?: number; /** diff --git a/src/apis/cloudtasks/webpack.config.js b/src/apis/cloudtasks/webpack.config.js index 9fab69e9c11..dde4d7c122c 100644 --- a/src/apis/cloudtasks/webpack.config.js +++ b/src/apis/cloudtasks/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/cloudtrace/package.json b/src/apis/cloudtrace/package.json index b505f643849..85523379554 100644 --- a/src/apis/cloudtrace/package.json +++ b/src/apis/cloudtrace/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/cloudtrace/v1.ts b/src/apis/cloudtrace/v1.ts index c8487d32b47..ac79204927d 100644 --- a/src/apis/cloudtrace/v1.ts +++ b/src/apis/cloudtrace/v1.ts @@ -220,7 +220,7 @@ export namespace cloudtrace_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudTrace = google.cloudtrace('v1'); * * authorize(function(authClient) { @@ -245,16 +245,12 @@ export namespace cloudtrace_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudtrace.projects.patchTraces @@ -370,7 +366,7 @@ export namespace cloudtrace_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudTrace = google.cloudtrace('v1'); * * authorize(function(authClient) { @@ -396,16 +392,12 @@ export namespace cloudtrace_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudtrace.projects.traces.get @@ -495,7 +487,7 @@ export namespace cloudtrace_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var cloudTrace = google.cloudtrace('v1'); * * authorize(function(authClient) { @@ -531,16 +523,12 @@ export namespace cloudtrace_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias cloudtrace.projects.traces.list diff --git a/src/apis/cloudtrace/v2.ts b/src/apis/cloudtrace/v2.ts index 2fe4458687a..dedaa067b6a 100644 --- a/src/apis/cloudtrace/v2.ts +++ b/src/apis/cloudtrace/v2.ts @@ -358,7 +358,7 @@ export namespace cloudtrace_v2 { stackTraceHashId?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/cloudtrace/webpack.config.js b/src/apis/cloudtrace/webpack.config.js index 2d18c508477..f0698e54db7 100644 --- a/src/apis/cloudtrace/webpack.config.js +++ b/src/apis/cloudtrace/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/commentanalyzer/package.json b/src/apis/commentanalyzer/package.json index e0ff69ec3df..8e01d62febe 100644 --- a/src/apis/commentanalyzer/package.json +++ b/src/apis/commentanalyzer/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/commentanalyzer/v1alpha1.ts b/src/apis/commentanalyzer/v1alpha1.ts index 077cb21346b..0b85f7ec769 100644 --- a/src/apis/commentanalyzer/v1alpha1.ts +++ b/src/apis/commentanalyzer/v1alpha1.ts @@ -171,11 +171,11 @@ export namespace commentanalyzer_v1alpha1 { */ clientToken?: string; /** - * Contains the language as detected from the text content. If no language was specified in the request, the first (the most likely) language is used to select an appropriate model. Sorted in order of likelihood. + * Contains the languages detected from the text content, sorted in order of likelihood. */ detectedLanguages?: string[]; /** - * The language(s) requested by the client, as specified in the request. If the request did not specify any language, this will be empty and the detected_languages field will be populated. + * The language(s) used by CommentAnalyzer service to choose which Model to use when analyzing the comment. Might better be called "effective_languages". The logic used to make the choice is as follows: if Request.languages.empty() effective_languages = detected_languages else effective_languages = Request.languages */ languages?: string[]; } diff --git a/src/apis/commentanalyzer/webpack.config.js b/src/apis/commentanalyzer/webpack.config.js index 7dcaef73cc7..98fb336678a 100644 --- a/src/apis/commentanalyzer/webpack.config.js +++ b/src/apis/commentanalyzer/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/composer/package.json b/src/apis/composer/package.json index c8b995b211a..31f6bee890d 100644 --- a/src/apis/composer/package.json +++ b/src/apis/composer/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/composer/v1.ts b/src/apis/composer/v1.ts index 07ac768e4fb..ab27ee8d947 100644 --- a/src/apis/composer/v1.ts +++ b/src/apis/composer/v1.ts @@ -293,7 +293,7 @@ export namespace composer_v1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -356,7 +356,7 @@ export namespace composer_v1 { pythonVersion?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -710,7 +710,7 @@ export namespace composer_v1 { * * @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 numpy, the `updateMask` parameter would include the following two `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". 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 numpy 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 {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 numpy, the `updateMask` parameter would include the following two `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". 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 numpy 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. @@ -849,7 +849,7 @@ export namespace composer_v1 { */ name?: string; /** - * 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 numpy, the `updateMask` parameter would include the following two `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". 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 numpy 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.
+ * 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 numpy, the `updateMask` parameter would include the following two `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". 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 numpy 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.
*/ updateMask?: string; diff --git a/src/apis/composer/v1beta1.ts b/src/apis/composer/v1beta1.ts index 50911913ebc..7e04c264665 100644 --- a/src/apis/composer/v1beta1.ts +++ b/src/apis/composer/v1beta1.ts @@ -326,7 +326,7 @@ export namespace composer_v1beta1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -415,7 +415,7 @@ export namespace composer_v1beta1 { pythonVersion?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -769,7 +769,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.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.
config.softwareConfig.imageVersion Upgrade the version of the environment in-place. Refer to `SoftwareConfig.image_version` for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade and must match the current image version's Composer major version and Airflow major and minor versions. Consult the Cloud Composer Version List for valid values.
+ * @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.
config.softwareConfig.imageVersion Upgrade the version of the environment in-place. Refer to `SoftwareConfig.image_version` for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade and must match the current image version's Composer major version and Airflow major and minor versions. Consult the Cloud Composer Version List for valid values.
* @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. @@ -908,7 +908,7 @@ export namespace composer_v1beta1 { */ name?: string; /** - * 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.
config.softwareConfig.imageVersion Upgrade the version of the environment in-place. Refer to `SoftwareConfig.image_version` for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade and must match the current image version's Composer major version and Airflow major and minor versions. Consult the Cloud Composer Version List for valid values.
+ * 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.
config.softwareConfig.imageVersion Upgrade the version of the environment in-place. Refer to `SoftwareConfig.image_version` for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade and must match the current image version's Composer major version and Airflow major and minor versions. Consult the Cloud Composer Version List for valid values.
*/ updateMask?: string; diff --git a/src/apis/composer/webpack.config.js b/src/apis/composer/webpack.config.js index d6721fd7b5d..baaf8729de1 100644 --- a/src/apis/composer/webpack.config.js +++ b/src/apis/composer/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index 9392c5eccae..14869d24e95 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -125,6 +125,7 @@ export namespace compute_alpha { nodeTemplates: Resource$Nodetemplates; nodeTypes: Resource$Nodetypes; organizationSecurityPolicies: Resource$Organizationsecuritypolicies; + packetMirrorings: Resource$Packetmirrorings; projects: Resource$Projects; regionAutoscalers: Resource$Regionautoscalers; regionBackendServices: Resource$Regionbackendservices; @@ -222,6 +223,7 @@ export namespace compute_alpha { this.organizationSecurityPolicies = new Resource$Organizationsecuritypolicies( this.context ); + this.packetMirrorings = new Resource$Packetmirrorings(this.context); this.projects = new Resource$Projects(this.context); this.regionAutoscalers = new Resource$Regionautoscalers(this.context); this.regionBackendServices = new Resource$Regionbackendservices( @@ -293,7 +295,7 @@ export namespace compute_alpha { acceleratorType?: string; } /** - * An Accelerator Type resource. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==) + * Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==) */ export interface Schema$AcceleratorType { /** @@ -423,7 +425,7 @@ export namespace compute_alpha { */ kind?: string; /** - * The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. + * The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. */ name?: string; /** @@ -439,7 +441,7 @@ export namespace compute_alpha { */ publicDnsName?: string; /** - * The DNS domain name for the public PTR record. This field can only be set when the set_public_ptr field is enabled. + * The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled. */ publicPtrDomainName?: string; /** @@ -447,7 +449,7 @@ export namespace compute_alpha { */ setPublicDns?: boolean; /** - * Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name. + * Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. */ setPublicPtr?: boolean; /** @@ -456,7 +458,7 @@ export namespace compute_alpha { type?: string; } /** - * A reserved address resource. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==) + * Represents an IP Address resource. An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses. A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==) */ export interface Schema$Address { /** @@ -472,7 +474,7 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you create the resource. + * An optional description of this resource. Provide this field when you create the resource. */ description?: string; /** @@ -480,7 +482,7 @@ export namespace compute_alpha { */ id?: string; /** - * The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. + * The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. */ ipVersion?: string; /** @@ -496,15 +498,15 @@ export namespace compute_alpha { */ labels?: {[key: string]: 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 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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. */ name?: string; /** - * The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with VPC_PEERING purpose. + * The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose. */ network?: string; /** - * This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM, STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a Network load balancer. If this field is not specified, it is assumed to be PREMIUM. + * This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer. If this field is not specified, it is assumed to be PREMIUM. */ networkTier?: string; /** @@ -512,11 +514,11 @@ export namespace compute_alpha { */ prefixLength?: number; /** - * The purpose of resource, only used with INTERNAL type. + * The purpose of this resource, which can be one of the following values: - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. - `DNS_RESOLVER` for a DNS resolver address in a subnetwork - `VPC_PEERING` for addresses that are reserved for VPC peer networks. - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT. */ purpose?: 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 as part of the HTTP request URL. You cannot set this field in the request body. + * [Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL. */ region?: string; /** @@ -532,7 +534,7 @@ export namespace compute_alpha { */ status?: string; /** - * The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. + * The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose. */ subnetwork?: string; /** @@ -622,11 +624,11 @@ export namespace compute_alpha { */ export interface Schema$AliasIpRange { /** - * The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24). + * The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24). */ ipCidrRange?: string; /** - * Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. + * The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. */ subnetworkRangeName?: string; } @@ -715,7 +717,7 @@ export namespace compute_alpha { */ initializeParams?: Schema$AttachedDiskInitializeParams; /** - * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. + * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. TODO(b/131765817): Update documentation when NVME is supported. */ interface?: string; /** @@ -867,7 +869,7 @@ export namespace compute_alpha { permissionType?: string; } /** - * Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==) + * Represents an Autoscaler resource. Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==) */ export interface Schema$Autoscaler { /** @@ -1050,6 +1052,7 @@ export namespace compute_alpha { * Configuration parameters of autoscaling based on queuing system. */ queueBasedScaling?: Schema$AutoscalingPolicyQueueBasedScaling; + scaleDownControl?: Schema$AutoscalingPolicyScaleDownControl; } /** * CPU utilization policy. @@ -1124,12 +1127,25 @@ export namespace compute_alpha { */ topic?: string; } + /** + * Configuration that allows for slower scale down so that even if Autoscaler recommends an abrupt scale down of a MIG, it will be throttled as specified by the parameters below. + */ + export interface Schema$AutoscalingPolicyScaleDownControl { + /** + * Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step. + */ + maxScaledDownReplicas?: Schema$FixedOrPercent; + /** + * How long back autoscaling should look when computing recommendations to include directives regarding slower scale down, as described above. + */ + timeWindowSec?: number; + } /** * Message containing information of one individual backend. */ export interface Schema$Backend { /** - * Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). For Internal Load Balancing, the default and only supported mode is CONNECTION. + * Specifies the balancing mode for the backend. When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG). - If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle. The CONNECTION balancing mode is only available if the protocol for the backend service is SSL, TCP, or UDP. If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters. - If the load balancing mode is RATE, then the load is spread based on the rate of HTTP requests per second (RPS). The RATE balancing mode is only available if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate, maxRatePerInstance, or maxRatePerEndpoint. - If the load balancing mode is UTILIZATION, then the load is spread based on the CPU utilization of instances in an instance group. The UTILIZATION balancing mode is only available if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backend is made up of instance groups. There are no restrictions on the backend service protocol. */ balancingMode?: string; /** @@ -1145,19 +1161,19 @@ export namespace compute_alpha { */ failover?: boolean; /** - * The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group. Backend service can not contain mix of Instance Group and Network Endpoint Group backends. Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL. When the BackendService has load balancing scheme INTERNAL, the instance group must be within the same region as the BackendService. Network Endpoint Groups are not supported for INTERNAL load balancing scheme. + * The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme. - When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. - When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. */ group?: string; /** - * The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing. + * Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION. */ maxConnections?: number; /** - * The max number of simultaneous connections that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set. This cannot be used for internal load balancing. + * Defines a maximum target for simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION. */ maxConnectionsPerEndpoint?: number; /** - * The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing. + * Defines a maximum target for simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION. */ maxConnectionsPerInstance?: number; /** @@ -1165,20 +1181,20 @@ export namespace compute_alpha { */ maxRate?: number; /** - * The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set. This cannot be used for internal load balancing. + * Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerInstance. Not available if the backend's balancingMode is CONNECTION. */ maxRatePerEndpoint?: number; /** - * The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing. + * Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerEndpoint. Not available if the backend's balancingMode is CONNECTION. */ maxRatePerInstance?: number; /** - * Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0]. This cannot be used for internal load balancing. + * Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION. This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections, or maxConnectionsPerInstance. */ maxUtilization?: number; } /** - * A BackendBucket resource. This resource defines a Cloud Storage bucket. + * Represents a Cloud Storage Bucket resource. This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets. */ export interface Schema$BackendBucket { /** @@ -1269,17 +1285,13 @@ export namespace compute_alpha { }; } /** - * A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) + * Represents a Backend Service resource. Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services. A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director. A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) */ export interface Schema$BackendService { /** - * Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used. + * If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is one day (86,400). */ affinityCookieTtlSec?: number; - /** - * Directs request to an App Engine app. cloudFunctionBackend and backends[] must be empty if this is set. - */ - appEngineBackend?: Schema$BackendServiceAppEngineBackend; /** * The list of backends that serve this BackendService. */ @@ -1292,10 +1304,6 @@ export namespace compute_alpha { * Settings controlling the volume of connections to a backend service. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. */ circuitBreakers?: Schema$CircuitBreakers; - /** - * Directs request to a cloud function. appEngineBackend and backends[] must be empty if this is set. - */ - cloudFunctionBackend?: Schema$BackendServiceCloudFunctionBackend; connectionDraining?: Schema$ConnectionDraining; /** * Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. @@ -1314,9 +1322,12 @@ export namespace compute_alpha { */ description?: string; /** - * If true, enable Cloud CDN for this BackendService. When the load balancing scheme is INTERNAL, this field is not used. + * If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS. */ enableCDN?: boolean; + /** + * Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend. + */ failoverPolicy?: Schema$BackendServiceFailoverPolicy; /** * 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, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService. @@ -1351,20 +1362,24 @@ export namespace compute_alpha { * 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 URL of the network to which this backend service belongs. This field can only be spcified when the load balancing scheme is set to INTERNAL. + */ + network?: string; /** * Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. */ outlierDetection?: Schema$OutlierDetection; /** - * Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. This cannot be used for internal load balancing. + * Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing). */ port?: number; /** - * Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. When the load balancing scheme is INTERNAL, this field is not used. + * A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Blaancing). */ portName?: string; /** - * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. For internal load balancing, the possible values are TCP and UDP, and the default is TCP. + * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic director for more information. */ protocol?: string; /** @@ -1388,11 +1403,11 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * Type of session affinity to use. The default is NONE. When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the protocol is UDP, this field is not used. + * Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP. When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. GENERATED_COOKIE is only available if the protocol is HTTP or HTTPS. When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the loadBalancingScheme is INTERNAL_SELF_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE. */ sessionAffinity?: string; /** - * How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. + * The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds. */ timeoutSec?: number; } @@ -1429,23 +1444,6 @@ export namespace compute_alpha { message?: string; }; } - /** - * Configuration of a App Engine backend. - */ - export interface Schema$BackendServiceAppEngineBackend { - /** - * Optional. App Engine app service name. - */ - appEngineService?: string; - /** - * Required. Project ID of the project hosting the app. This is the project ID of this project. Reference to another project is not allowed. - */ - targetProject?: string; - /** - * Optional. Version of App Engine app service. When empty, App Engine will do its normal traffic split. - */ - version?: string; - } /** * Message containing Cloud CDN configuration for a backend service. */ @@ -1463,30 +1461,17 @@ export namespace compute_alpha { */ signedUrlKeyNames?: string[]; } - /** - * Configuration of a Cloud Function backend. - */ - export interface Schema$BackendServiceCloudFunctionBackend { - /** - * Required. A cloud function name. Special value ?*? represents all cloud functions in the project. - */ - functionName?: string; - /** - * Required. Project ID of the project hosting the cloud function. - */ - targetProject?: string; - } export interface Schema$BackendServiceFailoverPolicy { /** - * On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false. + * This can be set to true only if the protocol is TCP. The default is false. */ disableConnectionDrainOnFailover?: boolean; /** - * This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false. + * Applicable only to Failover for Internal TCP/UDP Load Balancing. If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy. If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. The default is false. */ dropTrafficIfUnhealthy?: boolean; /** - * The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing. + * Applicable only to Failover for Internal TCP/UDP Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. */ failoverRatio?: number; } @@ -1597,6 +1582,151 @@ export namespace compute_alpha { message?: string; }; } + export interface Schema$BfdPacket { + /** + * The Authentication Present bit of the BFD packet. This is specified in section 4.1 of RFC5880 + */ + authenticationPresent?: boolean; + /** + * The Control Plane Independent bit of the BFD packet. This is specified in section 4.1 of RFC5880 + */ + controlPlaneIndependent?: boolean; + /** + * The demand bit of the BFD packet. This is specified in section 4.1 of RFC5880 + */ + demand?: boolean; + /** + * The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880 + */ + diagnostic?: string; + /** + * The Final bit of the BFD packet. This is specified in section 4.1 of RFC5880 + */ + final?: boolean; + /** + * The length of the BFD Control packet in bytes. This is specified in section 4.1 of RFC5880 + */ + length?: number; + /** + * The Required Min Echo RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880 + */ + minEchoRxIntervalMs?: number; + /** + * The Required Min RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880 + */ + minRxIntervalMs?: number; + /** + * The Desired Min TX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880 + */ + minTxIntervalMs?: number; + /** + * The detection time multiplier of the BFD packet. This is specified in section 4.1 of RFC5880 + */ + multiplier?: number; + /** + * The multipoint bit of the BFD packet. This is specified in section 4.1 of RFC5880 + */ + multipoint?: boolean; + /** + * The My Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880 + */ + myDiscriminator?: number; + /** + * The Poll bit of the BFD packet. This is specified in section 4.1 of RFC5880 + */ + poll?: boolean; + /** + * The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880 + */ + state?: string; + /** + * The version number of the BFD protocol, as specified in section 4.1 of RFC5880. + */ + version?: number; + /** + * The Your Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880 + */ + yourDiscriminator?: number; + } + /** + * Next free: 15 + */ + export interface Schema$BfdStatus { + /** + * The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. + */ + bfdSessionInitializationMode?: string; + /** + * Unix timestamp of the most recent config update. + */ + configUpdateTimestampMicros?: string; + /** + * Control packet counts for the current BFD session. + */ + controlPacketCounts?: Schema$BfdStatusPacketCounts; + /** + * Inter-packet time interval statistics for control packets. + */ + controlPacketIntervals?: Schema$PacketIntervals[]; + /** + * Echo packet counts for the current BFD session. + */ + echoPacketCounts?: Schema$BfdStatusPacketCounts; + /** + * Inter-packet time interval statistics for echo packets. + */ + echoPacketIntervals?: Schema$PacketIntervals[]; + /** + * The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880 + */ + localDiagnostic?: string; + /** + * The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880 + */ + localState?: string; + /** + * Negotiated transmit interval for control packets. When echo mode is enabled this will reflect the negotiated slow timer interval. + */ + negotiatedLocalControlTxIntervalMs?: number; + /** + * Negotiated transmit interval for echo packets. + */ + negotiatedLocalEchoTxIntervalMs?: number; + /** + * The most recent Rx control packet for this BFD session. + */ + rxPacket?: Schema$BfdPacket; + /** + * The most recent Tx control packet for this BFD session. + */ + txPacket?: Schema$BfdPacket; + /** + * Session uptime in milliseconds. Value will be 0 if session is not up. + */ + uptimeMs?: string; + /** + * Indicates if echo mode is currently being used. + */ + usingEchoMode?: boolean; + } + export interface Schema$BfdStatusPacketCounts { + /** + * Number of packets received since the beginning of the current BFD session. + */ + numRx?: number; + /** + * Number of packets received that were rejected because of errors since the beginning of the current BFD session. + */ + numRxRejected?: number; + /** + * Number of packets received that were successfully processed since the beginning of the current BFD session. + */ + numRxSuccessful?: number; + /** + * Number of packets transmitted since the beginning of the current BFD session. + */ + numTx?: number; + } /** * Associates `members` with a `role`. */ @@ -1650,10 +1780,6 @@ export namespace compute_alpha { * gRPC call credentials to access the SDS server. */ export interface Schema$CallCredentials { - /** - * The access token that is used as call credential for the SDS server. This field is used only if callCredentialType is ACCESS_TOKEN. - */ - accessToken?: string; /** * The type of call credentials to use for GRPC requests to the SDS server. This field can be set to one of the following: ACCESS_TOKEN: An access token is used as call credentials for the SDS server. GCE_VM: The local GCE VM service account credentials are used to access the SDS server. JWT_SERVICE_TOKEN: The user provisioned service account credentials are used to access the SDS server. FROM_PLUGIN: Custom authenticator credentials are used to access the SDS server. */ @@ -1662,10 +1788,6 @@ export namespace compute_alpha { * Custom authenticator credentials. */ fromPlugin?: Schema$MetadataCredentialsFromPlugin; - /** - * This service account credentials are used as call credentials for the SDS server. This field is used only if callCredentialType is JWT_SERVICE_ACCOUNT. - */ - jwtServiceAccount?: Schema$ServiceAccountJwtAccessCredentials; } /** * gRPC channel credentials to access the SDS server. @@ -1731,7 +1853,7 @@ export namespace compute_alpha { subjectAltNames?: string[]; } /** - * Represents a Commitment resource. Creating a Commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. Committed use discounts are subject to Google Cloud Platform's Service Specific Terms. By purchasing a committed use discount, you agree to these terms. Committed use discounts will not renew, so you must purchase a new commitment to continue receiving discounts. (== resource_for beta.commitments ==) (== resource_for v1.commitments ==) + * Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==) */ export interface Schema$Commitment { /** @@ -1906,7 +2028,7 @@ export namespace compute_alpha { */ export interface Schema$ConnectionDraining { /** - * Time for which instance will be drained (not accept new connections, but still work to finish started). + * The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600]. */ drainingTimeoutSec?: number; } @@ -2039,7 +2161,7 @@ export namespace compute_alpha { state?: string; } /** - * A Disk resource. (== resource_for beta.disks ==) (== resource_for v1.disks ==) + * Represents a Persistent Disk resource. Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for beta.disks ==) (== resource_for v1.disks ==) (== resource_for v1.regionDisks ==) (== resource_for beta.regionDisks ==) */ export interface Schema$Disk { /** @@ -2051,9 +2173,13 @@ export namespace compute_alpha { */ description?: string; /** - * Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. + * Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature. + */ + eraseWindowsVssSignature?: boolean; /** * 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. */ @@ -2122,6 +2248,10 @@ export namespace compute_alpha { * [Output Only] Server-defined fully-qualified URL for this resource. */ selfLink?: string; + /** + * [Output Only] Server-defined URL for this resource's resource id. + */ + selfLinkWithId?: string; /** * Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive. */ @@ -2167,11 +2297,11 @@ export namespace compute_alpha { */ storageType?: string; /** - * URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: project/zones/zone/diskTypes/pd-standard or pd-ssd + * URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd */ type?: string; /** - * [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance + * [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance */ users?: string[]; /** @@ -2306,7 +2436,7 @@ export namespace compute_alpha { }; } /** - * A DiskType resource. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==) + * Represents a Disk Type resource. You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==) (== resource_for v1.regionDiskTypes ==) (== resource_for beta.regionDiskTypes ==) */ export interface Schema$DiskType { /** @@ -2475,7 +2605,7 @@ export namespace compute_alpha { */ destRange?: string; /** - * If the peering route is imported if there is no confliction. + * True if the peering route has been imported from a peer. The actual import happens if the field networkPeering.importCustomRoutes is true for this network, and networkPeering.exportCustomRoutes is true for the peer network, and the import does not result in a route conflict. */ imported?: boolean; /** @@ -2642,7 +2772,7 @@ export namespace compute_alpha { fileType?: string; } /** - * Represents a Firewall resource. + * Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules. */ export interface Schema$Firewall { /** @@ -2658,19 +2788,19 @@ export namespace compute_alpha { */ denied?: Array<{IPProtocol?: string; ports?: string[]}>; /** - * An optional description of this resource. Provide this property when you create the resource. + * An optional description of this resource. Provide this field when you create the resource. */ description?: string; /** - * If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. + * If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. */ destinationRanges?: string[]; /** - * Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags. + * Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields. */ direction?: string; /** - * Denotes whether the firewall rule is disabled, i.e not applied to the network it is associated with. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. + * Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. */ disabled?: boolean; /** @@ -2690,15 +2820,15 @@ export namespace compute_alpha { */ logConfig?: Schema$FirewallLogConfig; /** - * 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 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. */ name?: string; /** - * URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default + * URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default */ network?: string; /** - * Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority. + * Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`. */ priority?: number; /** @@ -2710,15 +2840,15 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported. + * If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported. */ sourceRanges?: string[]; /** - * If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. + * If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. */ sourceServiceAccounts?: string[]; /** - * If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. + * If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply. */ sourceTags?: string[]; /** @@ -2794,7 +2924,7 @@ export namespace compute_alpha { percent?: number; } /** - * A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, ports] tuple. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) + * Represents a Forwarding Rule resource. A forwardingRules resource represents a regional forwarding rule. Regional external forwarding rules can reference any of the following resources: - A target instance - A Cloud VPN Classic gateway (targetVpnGateway), - A target pool for a Network Load Balancer - A global target HTTP(S) proxy for an HTTP(S) load balancer using Standard Tier - A target SSL proxy for a SSL Proxy load balancer using Standard Tier - A target TCP proxy for a TCP Proxy load balancer using Standard Tier. Regional internal forwarding rules can reference the backend service of an internal TCP/UDP load balancer. For regional internal forwarding rules, the following applies: - If the loadBalancingScheme for the load balancer is INTERNAL, then the forwarding rule references a regional internal backend service. - If the loadBalancingScheme for the load balancer is INTERNAL_MANAGED, then the forwarding rule must reference a regional target HTTP(S) proxy. For more information, read Using Forwarding rules. A globalForwardingRules resource represents a global forwarding rule. Global forwarding rules are only used by load balancers that use Premium Tier. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) */ export interface Schema$ForwardingRule { /** @@ -2837,6 +2967,10 @@ export namespace compute_alpha { * The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule. */ ipVersion?: string; + /** + * Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL. + */ + isMirroringCollector?: boolean; /** * [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. */ @@ -3101,7 +3235,7 @@ export namespace compute_alpha { type?: string; } /** - * An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. + * Represents a Health Check resource. Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts. To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks. */ export interface Schema$HealthCheck { /** @@ -3131,6 +3265,10 @@ export namespace compute_alpha { * Type of the resource. */ kind?: string; + /** + * Configure logging on this health check. + */ + logConfig?: Schema$HealthCheckLogConfig; /** * 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. */ @@ -3196,6 +3334,19 @@ export namespace compute_alpha { message?: string; }; } + /** + * Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. + */ + export interface Schema$HealthCheckLogConfig { + /** + * Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. + */ + enable?: boolean; + /** + * Specifies the desired filtering of logs on this health check. If this is unspecified and enable is true, logs are exported with LOG_TRANSITION filter. + */ + filter?: string; + } /** * A full or valid partial URL to a health check. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - projects/project-id/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check */ @@ -3285,6 +3436,12 @@ export namespace compute_alpha { */ selfLinkWithId?: string; } + /** + * A full or valid partial URL to a health check service. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service - projects/project-id/regions/us-west1/healthCheckServices/health-check-service - regions/us-west1/healthCheckServices/health-check-service + */ + export interface Schema$HealthCheckServiceReference { + healthCheckService?: string; + } export interface Schema$HealthCheckServicesList { /** * [Output Only] Unique identifier for the resource; defined by the server. @@ -3364,6 +3521,10 @@ export namespace compute_alpha { * URL of the health check associated with the health state of the network endpoint. */ healthCheck?: Schema$HealthCheckReference; + /** + * URL of the health check service associated with the health state of the network endpoint. + */ + healthCheckService?: Schema$HealthCheckServiceReference; /** * Health state of the network endpoint determined based on the health checks configured. */ @@ -3561,7 +3722,7 @@ export namespace compute_alpha { response?: string; } /** - * An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP. + * Represents a legacy HTTP Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. */ export interface Schema$HttpHealthCheck { /** @@ -3601,7 +3762,7 @@ export namespace compute_alpha { */ port?: number; /** - * The request path of the HTTP health check request. The default value is /. + * The request path of the HTTP health check request. The default value is /. This field does not support query parameters. */ requestPath?: string; /** @@ -3764,6 +3925,10 @@ export namespace compute_alpha { * In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. */ routeAction?: Schema$HttpRouteAction; + /** + * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. + */ + service?: string; /** * When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. */ @@ -3833,7 +3998,7 @@ export namespace compute_alpha { response?: string; } /** - * An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS. + * Represents a legacy HTTPS Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. */ export interface Schema$HttpsHealthCheck { /** @@ -3927,7 +4092,7 @@ export namespace compute_alpha { }; } /** - * An Image resource. (== resource_for beta.images ==) (== resource_for v1.images ==) + * Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for beta.images ==) (== resource_for v1.images ==) */ export interface Schema$Image { /** @@ -4110,7 +4275,7 @@ export namespace compute_alpha { pk?: Schema$FileContentBuffer; } /** - * An Instance resource. (== resource_for beta.instances ==) (== resource_for v1.instances ==) + * Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for beta.instances ==) (== resource_for v1.instances ==) */ export interface Schema$Instance { /** @@ -4141,6 +4306,10 @@ export namespace compute_alpha { * Enables display device for the instance. */ displayDevice?: Schema$DisplayDevice; + /** + * Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature. + */ + eraseWindowsVssSignature?: boolean; /** * A list of the type and count of accelerator cards attached to the instance. */ @@ -4191,7 +4360,7 @@ export namespace compute_alpha { */ preservedStateSizeGb?: string; /** - * The configuration of desired allocations which this Instance could consume capacity from. + * Specifies the reservations that this instance can consume from. */ reservationAffinity?: Schema$ReservationAffinity; /** @@ -4253,7 +4422,7 @@ export namespace compute_alpha { */ id?: string; /** - * A list of InstancesScopedList resources. + * An object that contains a list of instances scoped by zone. */ items?: {[key: string]: Schema$InstancesScopedList}; /** @@ -4278,7 +4447,7 @@ export namespace compute_alpha { }; } /** - * InstanceGroups (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) + * Represents an unmanaged Instance Group resource. Use unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. For more information, read Instance groups. For zonal unmanaged Instance Group, use instanceGroups resource. For regional unmanaged Instance Group, use regionInstanceGroups resource. (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) */ export interface Schema$InstanceGroup { /** @@ -4402,7 +4571,7 @@ export namespace compute_alpha { }; } /** - * An Instance Group Manager resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) + * Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) */ export interface Schema$InstanceGroupManager { /** @@ -4654,7 +4823,7 @@ export namespace compute_alpha { */ export interface Schema$InstanceGroupManagersApplyUpdatesRequest { /** - * The list of URLs of one or more instances for which we want to apply updates on this managed instance group. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; /** @@ -4662,11 +4831,11 @@ export namespace compute_alpha { */ maximalAction?: string; /** - * The minimal action that should be perfomed on the instances. By default NONE. + * The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update. */ minimalAction?: string; /** - * The most disruptive action that allowed to be performed on the instances. By default REPLACE. + * The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail. */ mostDisruptiveAllowedAction?: string; } @@ -4698,6 +4867,16 @@ export namespace compute_alpha { */ names?: string[]; } + export interface Schema$InstanceGroupManagersListErrorsResponse { + /** + * [Output Only] The list of errors of the managed instance group. + */ + items?: Schema$InstanceManagedByIgmError[]; + /** + * [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; + } export interface Schema$InstanceGroupManagersListManagedInstancesResponse { /** * [Output Only] The list of instances in the managed instance group. @@ -4789,11 +4968,21 @@ export namespace compute_alpha { * [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; + /** + * [Output Only] Stateful status of the given Instance Group Manager. + */ + stateful?: Schema$InstanceGroupManagerStatusStateful; /** * [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager. */ versionTarget?: Schema$InstanceGroupManagerStatusVersionTarget; } + export interface Schema$InstanceGroupManagerStatusStateful { + /** + * [Output Only] A bit indicating whether the managed instance group is stateful, i.e. has any disks in Stateful Policy or at least one per-instance config. This is determined based on the user intent, the group may be reported as not stateful even when there is still some preserved state on managed instances. + */ + isStateful?: boolean; + } export interface Schema$InstanceGroupManagerStatusVersionTarget { /** * [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager. @@ -4831,6 +5020,9 @@ export namespace compute_alpha { * What action should be used to replace instances. See minimal_action.REPLACE */ replacementMethod?: string; + /** + * The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls). + */ type?: string; } export interface Schema$InstanceGroupManagerVersion { @@ -4989,6 +5181,44 @@ export namespace compute_alpha { message?: string; }; } + export interface Schema$InstanceManagedByIgmError { + /** + * [Output Only] Contents of the error. + */ + error?: Schema$InstanceManagedByIgmErrorManagedInstanceError; + /** + * [Output Only] Details of the instance action that triggered this error. May be null, if the error was not caused by an action on an instance. This field is optional. + */ + instanceActionDetails?: Schema$InstanceManagedByIgmErrorInstanceActionDetails; + /** + * [Output Only] The time that this error occurred. This value is in RFC3339 text format. + */ + timestamp?: string; + } + export interface Schema$InstanceManagedByIgmErrorInstanceActionDetails { + /** + * [Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values: + */ + action?: string; + /** + * [Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created. + */ + instance?: string; + /** + * [Output Only] Version this instance was created from, or was being created from, but the creation failed. Corresponds to one of the versions that were set on the Instance Group Manager resource at the time this instance was being created. + */ + version?: Schema$ManagedInstanceVersion; + } + export interface Schema$InstanceManagedByIgmErrorManagedInstanceError { + /** + * [Output Only] Error code. + */ + code?: string; + /** + * [Output Only] Error message. + */ + message?: string; + } export interface Schema$InstanceMoveRequest { /** * The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone @@ -5041,7 +5271,7 @@ export namespace compute_alpha { */ networkInterfaces?: Schema$NetworkInterface[]; /** - * The configuration of desired reservations which this Instance could consume capacity from. + * Specifies the reservations that this instance can consume from. */ reservationAffinity?: Schema$ReservationAffinity; /** @@ -5152,6 +5382,16 @@ export namespace compute_alpha { */ minCpuPlatform?: string; } + export interface Schema$InstancesSetNameRequest { + /** + * The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name. + */ + currentName?: string; + /** + * The name to be applied to the instance. Needs to be RFC 1035 compliant. + */ + name?: string; + } export interface Schema$InstancesSetServiceAccountRequest { /** * Email address of the service account. @@ -5173,7 +5413,7 @@ export namespace compute_alpha { instanceEncryptionKey?: Schema$CustomerEncryptionKey; } /** - * An Instance Template resource. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==) + * Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==) */ export interface Schema$InstanceTemplate { /** @@ -5278,7 +5518,7 @@ export namespace compute_alpha { rangeStart?: string; } /** - * Represents an Interconnects resource. The Interconnects resource is a dedicated connection between Google's network and your on-premises network. For more information, see the Dedicated overview page. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) + * Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) */ export interface Schema$Interconnect { /** @@ -5322,7 +5562,7 @@ export namespace compute_alpha { */ interconnectAttachments?: string[]; /** - * Type of interconnect. Note that "IT_PRIVATE" has been deprecated in favor of "DEDICATED" + * Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. */ interconnectType?: string; /** @@ -5338,7 +5578,7 @@ export namespace compute_alpha { */ labels?: {[key: string]: string}; /** - * Type of link requested. This field indicates speed of each of the links in the bundle, not the entire bundle. + * Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. */ linkType?: string; /** @@ -5354,7 +5594,7 @@ export namespace compute_alpha { */ nocContactEmail?: string; /** - * [Output Only] The current status of whether or not this Interconnect is functional. + * [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. */ operationalStatus?: string; /** @@ -5378,12 +5618,12 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * [Output Only] The current state of whether or not this Interconnect is functional. + * [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. */ state?: string; } /** - * Represents an InterconnectAttachment (VLAN attachment) resource. For more information, see Creating VLAN Attachments. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==) + * Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==) */ export interface Schema$InterconnectAttachment { /** @@ -5391,7 +5631,7 @@ export namespace compute_alpha { */ adminEnabled?: boolean; /** - * Provisioned bandwidth capacity for the interconnectAttachment. Can be set by the partner to update the customer's provisioned bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED. + * Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s */ bandwidth?: string; /** @@ -5415,11 +5655,11 @@ export namespace compute_alpha { */ description?: string; /** - * Desired availability domain for the attachment. Only available for type PARTNER, at creation time. For improved reliability, customers should configure a pair of attachments with one per availability domain. The selected availability domain will be provided to the Partner via the pairing key so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. + * Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. */ edgeAvailabilityDomain?: string; /** - * [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. + * [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used. */ googleReferenceId?: string; /** @@ -5447,7 +5687,7 @@ export namespace compute_alpha { */ name?: string; /** - * [Output Only] The current status of whether or not this interconnect attachment is functional. + * [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. */ operationalStatus?: string; /** @@ -5455,7 +5695,7 @@ export namespace compute_alpha { */ pairingKey?: string; /** - * Optional BGP ASN for the router that should be supplied by a layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. + * Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. */ partnerAsn?: string; /** @@ -5483,9 +5723,12 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * [Output Only] The current state of this attachment's functionality. + * [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. */ state?: string; + /** + * The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. + */ type?: string; /** * The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. @@ -5568,7 +5811,7 @@ export namespace compute_alpha { */ partnerName?: string; /** - * URL of the Partner?s portal for this Attachment. Partners may customise this to be a deep-link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. + * URL of the Partner?s portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. */ portalUrl?: string; } @@ -5651,6 +5894,9 @@ export namespace compute_alpha { * System ID of the port on the neighbor?s side of the LACP exchange. */ neighborSystemId?: string; + /** + * The state of a LACP link, which can take one of the following values: - ACTIVE: The link is configured and active within the bundle. - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty. + */ state?: string; } export interface Schema$InterconnectDiagnosticsLinkOpticalPower { @@ -5720,7 +5966,7 @@ export namespace compute_alpha { }; } /** - * Represents an InterconnectLocations resource. The InterconnectLocations resource describes the locations where you can connect to Google's networks. For more information, see Colocation Facilities. + * Represents an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments. */ export interface Schema$InterconnectLocation { /** @@ -5736,7 +5982,7 @@ export namespace compute_alpha { */ city?: string; /** - * [Output Only] Continent for this location. + * [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA */ continent?: string; /** @@ -5784,7 +6030,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * [Output Only] The status of this InterconnectLocation. If the status is AVAILABLE, new Interconnects may be provisioned in this InterconnectLocation. Otherwise, no new Interconnects may be provisioned. + * [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. */ status?: string; } @@ -5855,7 +6101,7 @@ export namespace compute_alpha { */ endTime?: string; /** - * Form this outage is expected to take. Note that the "IT_" versions of this enum have been deprecated in favor of the unprefixed values. + * Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. */ issueType?: string; /** @@ -5863,7 +6109,7 @@ export namespace compute_alpha { */ name?: string; /** - * The party that generated this notification. Note that "NSRC_GOOGLE" has been deprecated in favor of "GOOGLE" + * The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. */ source?: string; /** @@ -5871,7 +6117,7 @@ export namespace compute_alpha { */ startTime?: string; /** - * State of this notification. Note that the "NS_" versions of this enum have been deprecated in favor of the unprefixed values. + * State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values. */ state?: string; } @@ -6210,7 +6456,7 @@ export namespace compute_alpha { */ export interface Schema$LogConfigDataAccessOptions { /** - * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152). + * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. */ logMode?: string; } @@ -6226,6 +6472,10 @@ export namespace compute_alpha { * An optional description of this resource. Provide this property when you create the resource. */ description?: string; + /** + * [Input Only] Specifies to create an application consistent machine image by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). + */ + guestFlush?: boolean; /** * [Output Only] A unique identifier for this machine image. The server defines this identifier. */ @@ -6235,7 +6485,7 @@ export namespace compute_alpha { */ kind?: string; /** - * Encryption key to protect the machine image. + * Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later. */ machineImageEncryptionKey?: Schema$CustomerEncryptionKey; /** @@ -6250,20 +6500,24 @@ export namespace compute_alpha { * [Output Only] Server-defined URL for this resource with the resource id. */ selfLinkWithId?: string; + /** + * [Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key. + */ + sourceDiskEncryptionKeys?: Schema$SourceDiskEncryptionKey[]; /** * The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance */ sourceInstance?: string; /** - * Properties of source instance. + * [Output Only] Properties of source instance. */ sourceInstanceProperties?: Schema$SourceInstanceProperties; /** - * [Output Only] The status of disk creation. + * [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING. */ status?: string; /** - * GCS bucket storage location of the snapshot (regional or multi-regional). + * GCS bucket storage location of the machine image (regional or multi-regional). */ storageLocations?: string[]; } @@ -6302,7 +6556,7 @@ export namespace compute_alpha { }; } /** - * A Machine Type resource. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==) + * Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==) */ export interface Schema$MachineType { /** @@ -6471,10 +6725,6 @@ export namespace compute_alpha { * [Output Only] Information about the last attempt to create or delete the instance. */ lastAttempt?: Schema$ManagedInstanceLastAttempt; - /** - * [Output Only] Override defined for this instance. - */ - override?: Schema$ManagedInstanceOverride; /** * [Output Only] Preserved state applied from per-instance config for this instance. */ @@ -6514,37 +6764,6 @@ export namespace compute_alpha { errors?: Array<{code?: string; location?: string; message?: string}>; }; } - /** - * Overrides of stateful properties for a given instance - */ - export interface Schema$ManagedInstanceOverride { - /** - * Disk overrides defined for this instance. According to documentation the maximum number of disks attached to an instance is 128: https://cloud.google.com/compute/docs/disks/ However, compute API defines the limit at 140, so this is what we check. - */ - disks?: Schema$ManagedInstanceOverrideDiskOverride[]; - /** - * Metadata overrides defined for this instance. TODO(b/69785416) validate the total length is <9 KB - */ - metadata?: Array<{key?: string; value?: string}>; - /** - * [Output Only] Indicates where does the override come from. - */ - origin?: string; - } - export interface Schema$ManagedInstanceOverrideDiskOverride { - /** - * The name of the device on the VM - */ - deviceName?: string; - /** - * The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. - */ - mode?: string; - /** - * The disk that is/will be mounted - */ - source?: string; - } export interface Schema$ManagedInstanceVersion { /** * [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }. @@ -6634,7 +6853,7 @@ export namespace compute_alpha { port?: number; } /** - * Represents a Network resource. Read Virtual Private Cloud (VPC) Network Overview for more information. (== resource_for v1.networks ==) (== resource_for beta.networks ==) + * Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==) */ export interface Schema$Network { /** @@ -6650,11 +6869,11 @@ export namespace compute_alpha { */ crossVmEncryption?: string; /** - * An optional description of this resource. Provide this property when you create the resource. + * An optional description of this resource. Provide this field when you create the resource. */ description?: string; /** - * [Output Only] The gateway address for default routing out of the network. This value is read only and is selected by GCP. + * [Output Only] The gateway address for default routing out of the network, selected by GCP. */ gatewayIPv4?: string; /** @@ -6673,12 +6892,16 @@ export namespace compute_alpha { * [Output Only] Type of LB-to-VM traffic encryption for this network. */ loadBalancerVmEncryption?: string; + /** + * Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1600 bytes. + */ + mtu?: number; /** * The multicast mode for this network. If set to ZONAL, multicast is allowed within a zone. If set to DISABLED, multicast is disabled for this network. The default is DISABLED. */ multicastMode?: 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 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. */ name?: string; /** @@ -6961,7 +7184,7 @@ export namespace compute_alpha { */ accessConfigs?: Schema$AccessConfig[]; /** - * An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. + * An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. */ aliasIpRanges?: Schema$AliasIpRange[]; /** @@ -6977,19 +7200,19 @@ export namespace compute_alpha { */ kind?: string; /** - * [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. + * [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. */ name?: string; /** - * URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network global/networks/default is used. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/network - projects/project/global/networks/network - global/networks/default + * URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/network - projects/project/global/networks/network - global/networks/default */ network?: string; /** - * An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. + * An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. */ networkIP?: string; /** - * The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - regions/region/subnetworks/subnetwork + * The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - regions/region/subnetworks/subnetwork */ subnetwork?: string; } @@ -7035,11 +7258,11 @@ export namespace compute_alpha { */ advertisePeerSubnetsViaRouters?: boolean; /** - * This field will be deprecated soon. Prefer using exchange_subnet_routes instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. + * This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ autoCreateRoutes?: boolean; /** - * Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. + * Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ exchangeSubnetRoutes?: boolean; /** @@ -7059,7 +7282,7 @@ export namespace compute_alpha { */ importSubnetRoutesWithPublicIp?: boolean; /** - * Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + * Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -7067,7 +7290,11 @@ export namespace compute_alpha { */ network?: string; /** - * [Output Only] State for the peering. + * Maximum Transmission Unit in bytes. + */ + peerMtu?: number; + /** + * [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. */ state?: string; /** @@ -7080,21 +7307,21 @@ export namespace compute_alpha { */ export interface Schema$NetworkRoutingConfig { /** - * The network-wide routing mode to use. If set to REGIONAL, this network's cloud routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's cloud routers will advertise routes with all subnets of this network, across regions. + * The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. */ routingMode?: string; } export interface Schema$NetworksAddPeeringRequest { /** - * This field will be deprecated soon. Prefer using exchange_subnet_routes in network_peering instead. Whether Google Compute Engine manages the routes automatically. + * This field will be deprecated soon. Use exchange_subnet_routes in network_peering instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ autoCreateRoutes?: boolean; /** - * This field will be deprecated soon. Prefer using export_custom_routes in network_peering instead. Whether to export the custom routes to peer network. + * This field will be deprecated soon. Use export_custom_routes in network_peering instead. Whether to export the custom routes to peer network. */ exportCustomRoutes?: boolean; /** - * This field will be deprecated soon. Prefer using import_custom_routes in network_peering instead. Whether to import the custom routes from peer network. + * This field will be deprecated soon. Use import_custom_routes in network_peering instead. Whether to import the custom routes from peer network. */ importCustomRoutes?: boolean; /** @@ -7102,7 +7329,7 @@ export namespace compute_alpha { */ name?: string; /** - * Network peering parameters. In order to specify route policies for peering using import/export custom routes, you will have to fill all peering related parameters (name, peer network, exchange_subnet_routes) in network_peeringfield. Corresponding fields in NetworksAddPeeringRequest will be deprecated soon. + * Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon. */ networkPeering?: Schema$NetworkPeering; /** @@ -7143,7 +7370,7 @@ export namespace compute_alpha { networkPeering?: Schema$NetworkPeering; } /** - * A NodeGroup resource. To create a node group, you must first create a node templates. To learn more about node groups and sole-tenant nodes, read the Sole-tenant nodes documentation. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) + * Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) NextID: 15 */ export interface Schema$NodeGroup { autoscalingPolicy?: Schema$NodeGroupAutoscalingPolicy; @@ -7163,7 +7390,7 @@ export namespace compute_alpha { * [Output Only] The type of the resource. Always compute#nodeGroup for node group. */ kind?: string; - managedHoldback?: string; + maintenancePolicy?: 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. */ @@ -7343,7 +7570,7 @@ export namespace compute_alpha { nodeTemplate?: string; } /** - * A Node Template resource. To learn more about node templates and sole-tenant nodes, read the Sole-tenant nodes documentation. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) + * Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) (== NextID: 16 ==) */ export interface Schema$NodeTemplate { /** @@ -7392,7 +7619,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * Binding properties for the physical server. + * Sets the binding properties for the physical server. Valid values include: - [Default] RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information. */ serverBinding?: Schema$ServerBinding; /** @@ -7487,7 +7714,7 @@ export namespace compute_alpha { }; } /** - * A Node Type resource. + * Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for beta.nodeTypes ==) (== resource_for v1.nodeTypes ==) */ export interface Schema$NodeType { /** @@ -7709,7 +7936,7 @@ export namespace compute_alpha { }; } /** - * An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) + * Represents an Operation resource. You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) */ export interface Schema$Operation { /** @@ -7767,7 +7994,7 @@ export namespace compute_alpha { */ progress?: number; /** - * [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + * [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. */ region?: string; /** @@ -7811,7 +8038,7 @@ export namespace compute_alpha { message?: string; }>; /** - * [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + * [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. */ zone?: string; } @@ -7957,6 +8184,266 @@ export namespace compute_alpha { */ successRateStdevFactor?: number; } + /** + * Next free: 7 + */ + export interface Schema$PacketIntervals { + /** + * Average observed inter-packet interval in milliseconds. + */ + avgMs?: string; + /** + * From how long ago in the past these intervals were observed. + */ + duration?: string; + /** + * Maximum observed inter-packet interval in milliseconds. + */ + maxMs?: string; + /** + * Minimum observed inter-packet interval in milliseconds. + */ + minMs?: string; + /** + * Number of inter-packet intervals from which these statistics were derived. + */ + numIntervals?: string; + /** + * The type of packets for which inter-packet intervals were computed. + */ + type?: string; + } + /** + * Represents a PacketMirroring resource. + */ + export interface Schema$PacketMirroring { + /** + * The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true. + */ + collectorIlb?: Schema$PacketMirroringForwardingRuleInfo; + /** + * PacketMirroring collectorInfos. Each collectorInfo specifies a set of collector VM instances, preferably in the same zone as the mirrored VM(s) + */ + collectors?: Schema$PacketMirroringCollectorInfo; + /** + * [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; + /** + * Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE. + */ + enable?: string; + /** + * Filter for mirrored traffic. If unspecified, all traffic is mirrored. + */ + filter?: Schema$PacketMirroringFilter; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string; + /** + * [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings. + */ + kind?: string; + /** + * PacketMirroring mirroredResourceInfos. Each mirroredResourceInfo specifies a set of mirrored VM instances and/or a set of subnetworks for which traffic from/to all VM instances will be mirrored. + */ + mirroredResources?: Schema$PacketMirroringMirroredResourceInfo; + /** + * 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; + /** + * Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network. + */ + network?: Schema$PacketMirroringNetworkInfo; + /** + * PacketMirroring packetMatchers. Each packetMatcher specifies a CIRD filter that will apply to the source or destination IP in the IP header for the mirrored VM traffic. + */ + packetMatchers?: Schema$PacketMirroringPacketMatcher[]; + /** + * The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535. + */ + priority?: number; + /** + * [Output Only] URI of the region where the packetMirroring resides. + */ + region?: string; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string; + } + /** + * Contains a list of packetMirrorings. + */ + export interface Schema$PacketMirroringAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of PacketMirroring resources. + */ + items?: {[key: string]: Schema$PacketMirroringsScopedList}; + /** + * 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?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } + export interface Schema$PacketMirroringCollectorInfo { + /** + * A set of virtual machines configured as destination of the mirrored traffic. They must live in zones contained in the same region as this packetMirroring. + */ + instances?: Schema$PacketMirroringCollectorInfoInstanceInfo[]; + } + export interface Schema$PacketMirroringCollectorInfoInstanceInfo { + /** + * Resource URL to the virtual machine instance configured as destination of the mirrored traffic. + */ + url?: string; + } + export interface Schema$PacketMirroringFilter { + /** + * IP CIDR ranges that apply as filter on the source (ingress) or destination (egress) IP in the IP header. Only IPv4 is supported. If no ranges are specified, all traffic that matches the specified IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored. + */ + cidrRanges?: string[]; + /** + * Protocols that apply as filter on mirrored traffic. If no protocols are specified, all traffic that matches the specified CIDR ranges is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored. + */ + IPProtocols?: string[]; + } + export interface Schema$PacketMirroringForwardingRuleInfo { + /** + * [Output Only] Unique identifier for the forwarding rule; defined by the server. + */ + canonicalUrl?: string; + /** + * Resource URL to the forwarding rule representing the ILB configured as destination of the mirrored traffic. + */ + url?: string; + } + /** + * Contains a list of PacketMirroring resources. + */ + export interface Schema$PacketMirroringList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of PacketMirroring resources. + */ + items?: Schema$PacketMirroring[]; + /** + * [Output Only] Type of resource. Always compute#packetMirroring for packetMirrorings. + */ + 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?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } + export interface Schema$PacketMirroringMirroredResourceInfo { + /** + * A set of virtual machine instances that are being mirrored. They must live in zones contained in the same region as this packetMirroring. Note that this config will apply only to those network interfaces of the Instances that belong to the network specified in this packetMirroring. You may specify a maximum of 50 Instances. + */ + instances?: Schema$PacketMirroringMirroredResourceInfoInstanceInfo[]; + /** + * A set of subnetworks for which traffic from/to all VM instances will be mirrored. They must live in zones contained in the same region as this packetMirroring. You may specify a maximum of 5 subnetworks. + */ + subnetworks?: Schema$PacketMirroringMirroredResourceInfoSubnetInfo[]; + /** + * A set of mirrored tags. Traffic from/to all VM instances that have one or more of these tags will be mirrored. + */ + tags?: string[]; + } + export interface Schema$PacketMirroringMirroredResourceInfoInstanceInfo { + /** + * [Output Only] Unique identifier for the instance; defined by the server. + */ + canonicalUrl?: string; + /** + * Resource URL to the virtual machine instance which is being mirrored. + */ + url?: string; + } + export interface Schema$PacketMirroringMirroredResourceInfoSubnetInfo { + /** + * [Output Only] Unique identifier for the subnetwork; defined by the server. + */ + canonicalUrl?: string; + /** + * Resource URL to the subnetwork for which traffic from/to all VM instances will be mirrored. + */ + url?: string; + } + export interface Schema$PacketMirroringNetworkInfo { + /** + * [Output Only] Unique identifier for the network; defined by the server. + */ + canonicalUrl?: string; + /** + * URL of the network resource. + */ + url?: string; + } + export interface Schema$PacketMirroringPacketMatcher { + /** + * IP CIDR range that applies as filter on the source or destination IP in the IP header. Only IPv4 is supported. + */ + cidrRange?: string; + } + export interface Schema$PacketMirroringsScopedList { + /** + * A list of packetMirrorings contained in this scope. + */ + packetMirrorings?: Schema$PacketMirroring[]; + /** + * Informational warning which replaces the list of packetMirrorings when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } /** * A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. */ @@ -8029,15 +8516,10 @@ export namespace compute_alpha { * Fingerprint of this per-instance config. This field may be used in optimistic locking. It will be ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance config or the field needs to be unset. */ fingerprint?: string; - /** - * The URL of the instance. Serves as a merge key during UpdatePerInstanceConfigs operation, i.e. if per-instance config with the same instance URL exists then it will be updated, otherwise a new one will be created. - */ - instance?: string; /** * The name of the per-instance config and the corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operation, i.e. if per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in a failure. */ name?: string; - override?: Schema$ManagedInstanceOverride; /** * Intended preserved state for the given instance. Does not contain state generated based on Stateful Policy. */ @@ -8202,7 +8684,7 @@ export namespace compute_alpha { users?: string[]; } /** - * A Project resource. For an overview of projects, see Cloud Platform Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) + * Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) */ export interface Schema$Project { /** @@ -8359,7 +8841,7 @@ export namespace compute_alpha { target?: string; } /** - * Region resource. (== resource_for beta.regions ==) (== resource_for v1.regions ==) + * Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for beta.regions ==) (== resource_for v1.regions ==) */ export interface Schema$Region { /** @@ -8593,7 +9075,7 @@ export namespace compute_alpha { */ export interface Schema$RegionInstanceGroupManagersApplyUpdatesRequest { /** - * The list of instances for which we want to apply changes on this managed instance group. + * The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; /** @@ -8601,11 +9083,11 @@ export namespace compute_alpha { */ maximalAction?: string; /** - * The minimal action that should be perfomed on the instances. By default NONE. + * The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update. */ minimalAction?: string; /** - * The most disruptive action that allowed to be performed on the instances. By default REPLACE. + * The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail. */ mostDisruptiveAllowedAction?: string; } @@ -8624,6 +9106,16 @@ export namespace compute_alpha { */ instances?: string[]; } + export interface Schema$RegionInstanceGroupManagersListErrorsResponse { + /** + * [Output Only] The list of errors of the managed instance group. + */ + items?: Schema$InstanceManagedByIgmError[]; + /** + * [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; + } export interface Schema$RegionInstanceGroupManagersListInstanceConfigsResp { /** * [Output Only] The list of PerInstanceConfig. @@ -8815,7 +9307,7 @@ export namespace compute_alpha { backendService?: string; } /** - * Reservation resource + * Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for beta.reservations ==) (== resource_for v1.reservations ==) (== NextID: 13 ==) */ export interface Schema$Reservation { /** @@ -8855,25 +9347,32 @@ export namespace compute_alpha { */ specificReservation?: Schema$AllocationSpecificSKUReservation; /** - * Indicates whether the reservation can be consumed by VMs with "any reservation" defined. If the field is set, then only VMs that target the reservation by name using --reservation-affinity can consume this reservation. + * Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. */ specificReservationRequired?: boolean; + /** + * [Output Only] The status of the reservation. + */ + status?: string; /** * Zone in which the reservation resides, must be provided if reservation is created with commitment creation. */ zone?: string; } /** - * AllocationAffinity is the configuration of desired allocation which this instance could take capacity from. + * Specifies the reservations that this instance can consume from. */ export interface Schema$ReservationAffinity { + /** + * Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples. + */ consumeReservationType?: string; /** - * Corresponds to the label key of reservation resource. + * Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value. */ key?: string; /** - * Corresponds to the label values of reservation resource. + * Corresponds to the label values of a reservation resource. */ values?: string[]; } @@ -9217,11 +9716,18 @@ export namespace compute_alpha { storageLocations?: string[]; } export interface Schema$ResourcePolicyVmMaintenancePolicy { + concurrencyControlGroup?: Schema$ResourcePolicyVmMaintenancePolicyConcurrencyControl; /** * Maintenance windows that are applied to VMs covered by this policy. */ maintenanceWindow?: Schema$ResourcePolicyVmMaintenancePolicyMaintenanceWindow; } + /** + * A concurrency control configuration. Defines a group config that, when attached to an instance, recognizes that instance as part of a group of instances where only up the concurrency_limit of instances in that group can undergo simultaneous maintenance. For more information: go/concurrency-control-design-doc + */ + export interface Schema$ResourcePolicyVmMaintenancePolicyConcurrencyControl { + concurrencyLimit?: number; + } /** * A maintenance window for VMs. When set, we restrict our maintenance operations to this window. */ @@ -9252,7 +9758,7 @@ export namespace compute_alpha { 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 ==) + * Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for beta.routes ==) (== resource_for v1.routes ==) */ export interface Schema$Route { /** @@ -9260,7 +9766,7 @@ export namespace compute_alpha { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you create the resource. + * An optional description of this resource. Provide this field when you create the resource. */ description?: string; /** @@ -9276,7 +9782,7 @@ export namespace compute_alpha { */ 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 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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. */ name?: string; /** @@ -9284,7 +9790,7 @@ export namespace compute_alpha { */ 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 + * 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/global/gateways/default-internet-gateway */ nextHopGateway?: string; /** @@ -9316,7 +9822,7 @@ export namespace compute_alpha { */ 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. + * 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 cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive. */ priority?: number; /** @@ -9374,7 +9880,7 @@ export namespace compute_alpha { }; } /** - * Router resource. + * Represents a Cloud Router resource. For more information about Cloud Router, read the the Cloud Router overview. */ export interface Schema$Router { /** @@ -9382,7 +9888,7 @@ export namespace compute_alpha { */ bgp?: Schema$RouterBgp; /** - * BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273. + * BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273. */ bgpPeers?: Schema$RouterBgpPeer[]; /** @@ -9398,7 +9904,7 @@ export namespace compute_alpha { */ id?: string; /** - * Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both. + * Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. */ interfaces?: Schema$RouterInterface[]; /** @@ -9410,7 +9916,7 @@ export namespace compute_alpha { */ name?: string; /** - * A list of Nat services created in this router. + * A list of NAT services created in this router. */ nats?: Schema$RouterNat[]; /** @@ -9486,7 +9992,7 @@ export namespace compute_alpha { */ advertisedIpRanges?: Schema$RouterAdvertisedIpRange[]; /** - * User-specified flag to indicate which mode to use for advertisement. + * User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM. */ advertiseMode?: string; /** @@ -9500,15 +10006,15 @@ export namespace compute_alpha { } export interface Schema$RouterBgpPeer { /** - * User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in Bgp message). These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. + * User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. */ advertisedGroups?: string[]; /** - * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in Bgp message). These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. + * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. */ advertisedIpRanges?: Schema$RouterAdvertisedIpRange[]; /** - * The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win. + * The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win. */ advertisedRoutePriority?: number; /** @@ -9532,7 +10038,7 @@ export namespace compute_alpha { */ ipAddress?: string; /** - * [Output Only] The resource that configures and manages this BGP peer. MANAGED_BY_USER is the default value and can be managed by you or other users; MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google will automatically create, update, and delete this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. + * [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. */ managementType?: string; /** @@ -9540,21 +10046,21 @@ export namespace compute_alpha { */ name?: string; /** - * Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel. + * Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. */ peerAsn?: number; /** - * IP address of the BGP interface outside Google cloud. Only IPv4 is supported. + * IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. */ peerIpAddress?: string; } export interface Schema$RouterBgpPeerBfd { /** - * The minimum interval, in milliseconds, between BFD packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If BFD echo mode is enabled on this router and the peer router, this value is used to negotiate the interval between BFD echo packets transmitted by the peer router. Otherwise, it will be used to determine the interval between BFD control packets. If set, this value must be between 33 and 30000. The default is 300. + * The minimum interval, in milliseconds, between BFD packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If BFD echo mode is enabled on this router and the peer router, this value is used to negotiate the interval between BFD echo packets transmitted by the peer router. Otherwise, it will be used to determine the interval between BFD control packets. If set, this value must be between 100 and 30000. The default is 300. */ minReceiveInterval?: number; /** - * The minimum interval, in milliseconds, between BFD packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If BFD echo mode is enabled on this router and the peer router, this value is used to negotiate the interval between BFD echo packets transmitted by this router. Otherwise, it will be used to determine the interval between BFD control packets. If set, this value must be between 33 and 30000. The default is 300. + * The minimum interval, in milliseconds, between BFD packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If BFD echo mode is enabled on this router and the peer router, this value is used to negotiate the interval between BFD echo packets transmitted by this router. Otherwise, it will be used to determine the interval between BFD control packets. If set, this value must be between 100 and 30000. The default is 300. */ minTransmitInterval?: number; /** @@ -9569,6 +10075,10 @@ export namespace compute_alpha { * The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO. */ packetMode?: string; + /** + * The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE. + */ + sessionInitializationMode?: string; /** * The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000. */ @@ -9576,19 +10086,19 @@ export namespace compute_alpha { } export interface Schema$RouterInterface { /** - * IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface. + * IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface. */ ipRange?: string; /** - * URI of the linked interconnect attachment. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment. + * URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be either be a VPN tunnel or an Interconnect attachment. */ linkedInterconnectAttachment?: string; /** - * URI of the linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment. + * URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be either a VPN tunnel or an Interconnect attachment. */ linkedVpnTunnel?: string; /** - * [Output Only] The resource that configures and manages this interface. MANAGED_BY_USER is the default value and can be managed by you or other users; MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google will automatically create, update, and delete this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. + * [Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. */ managementType?: string; /** @@ -9646,7 +10156,7 @@ export namespace compute_alpha { */ logConfig?: Schema$RouterNatLogConfig; /** - * Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This gets rounded up to the nearest power of 2. Eg. if the value of this field is 50, at least 64 ports will be allocated to a VM. + * Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM. */ minPortsPerVm?: number; /** @@ -9654,15 +10164,15 @@ export namespace compute_alpha { */ name?: string; /** - * Specify the NatIpAllocateOption. If it is AUTO_ONLY, then nat_ip should be empty. + * Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. */ natIpAllocateOption?: string; /** - * A list of URLs of the IP resources used for this Nat service. These IPs must be valid static external IP addresses assigned to the project. max_length is subject to change post alpha. + * A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project. */ natIps?: string[]; /** - * Specify the Nat option. If this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region. + * Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region. */ sourceSubnetworkIpRangesToNat?: string; /** @@ -9700,7 +10210,7 @@ export namespace compute_alpha { */ export interface Schema$RouterNatSubnetworkToNat { /** - * URL for the subnetwork resource to use NAT. + * URL for the subnetwork resource that will use NAT. */ name?: string; /** @@ -9708,7 +10218,7 @@ export namespace compute_alpha { */ secondaryIpRangeNames?: string[]; /** - * Specify the options for NAT ranges in the Subnetwork. All usages of single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] + * Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] */ sourceIpRangesToNat?: string[]; } @@ -9753,6 +10263,7 @@ export namespace compute_alpha { * Routes that were advertised to the remote BGP peer */ advertisedRoutes?: Schema$Route[]; + bfdStatus?: Schema$BfdStatus; /** * IP address of the local BGP interface. */ @@ -9880,15 +10391,15 @@ export namespace compute_alpha { */ boot?: boolean; /** - * Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. + * Specifies the name of the disk attached to the source instance. */ deviceName?: string; /** - * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Machine Images do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. + * The encryption key for the disk. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * The size of the disk in base-2 GB. This supersedes disk_size_gb in InitializeParams. + * The size of the disk in base-2 GB. */ diskSizeGb?: string; /** @@ -9896,15 +10407,11 @@ export namespace compute_alpha { */ guestOsFeatures?: Schema$GuestOsFeature[]; /** - * [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. + * Specifies zero-based index of the disk that is attached to the source instance. */ index?: number; /** - * [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. - */ - initializeParams?: Schema$AttachedDiskInitializeParams; - /** - * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. + * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. */ interface?: string; /** @@ -9916,19 +10423,15 @@ export namespace compute_alpha { */ licenses?: string[]; /** - * The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. + * The mode in which this disk is attached to the source instance, either READ_WRITE or READ_ONLY. */ mode?: string; /** - * For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api. - */ - savedState?: string; - /** - * Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for sourceMachineImage, specify the disk name, not the URL for the disk. + * Specifies a URL of the disk attached to the source instance. */ source?: string; /** - * [Output Only] A size of the storage used by the disk's snapshot. + * [Output Only] A size of the storage used by the disk's snapshot by this machine image. */ storageBytes?: string; /** @@ -9936,12 +10439,12 @@ export namespace compute_alpha { */ storageBytesStatus?: string; /** - * Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. + * Specifies the type of the attached disk, either SCRATCH or PERSISTENT. */ type?: string; } /** - * Sets the scheduling options for an Instance. + * Sets the scheduling options for an Instance. NextID: 9 */ export interface Schema$Scheduling { /** @@ -9957,7 +10460,7 @@ export namespace compute_alpha { */ minNodeCpus?: number; /** - * A set of node affinity and anti-affinity. + * A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. */ nodeAffinities?: Schema$SchedulingNodeAffinity[]; /** @@ -9978,7 +10481,7 @@ export namespace compute_alpha { */ key?: string; /** - * Defines the operation of node selection. + * Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. */ operator?: string; /** @@ -10002,13 +10505,14 @@ export namespace compute_alpha { wafRules?: Schema$PreconfiguredWafSet; } /** - * A security policy is comprised of one or more rules. It can also be associated with one or more 'targets'. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) + * Represents a Cloud Armor Security Policy resource. Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) */ export interface Schema$SecurityPolicy { /** * A list of assocations that belong to this policy. */ associations?: Schema$SecurityPolicyAssociation[]; + cloudArmorConfig?: Schema$SecurityPolicyCloudArmorConfig; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -10076,6 +10580,15 @@ export namespace compute_alpha { */ securityPolicyId?: string; } + /** + * Configuration options for Cloud Armor. + */ + export interface Schema$SecurityPolicyCloudArmorConfig { + /** + * If set to true, enables Cloud Armor Machine Learning. + */ + enableMl?: boolean; + } export interface Schema$SecurityPolicyList { /** * [Output Only] Unique identifier for the resource; defined by the server. @@ -10233,10 +10746,6 @@ export namespace compute_alpha { * TLS Settings for the backend service. */ clientTlsSettings?: Schema$ClientTlsSettings; - /** - * The listener config of the XDS client is generated if the selector matches the client. - */ - serverSettingsSelector?: Schema$ServerSecuritySettingsSelector; } /** * An instance's serial console output. @@ -10266,19 +10775,6 @@ export namespace compute_alpha { export interface Schema$ServerBinding { type?: string; } - /** - * A selector associated with the SecuritySettings. If the labels and port in this selector match the Envoy's label and port, the server side authentication and authorization settings are applied to the Envoy. - */ - export interface Schema$ServerSecuritySettingsSelector { - /** - * The labels associated with the XDS client. - */ - labelMatches?: Schema$MetadataFilterLabelMatch[]; - /** - * The listener port of the XDS client. - */ - port?: number; - } /** * The TLS settings for the server. */ @@ -10309,19 +10805,6 @@ export namespace compute_alpha { */ scopes?: string[]; } - /** - * JWT credentials for a service account. - */ - export interface Schema$ServiceAccountJwtAccessCredentials { - /** - * Service account key. - */ - jsonKey?: string; - /** - * The token lifetime seconds. - */ - tokenLifetimeSeconds?: string; - } /** * A set of Shielded Instance options. */ @@ -10448,7 +10931,7 @@ export namespace compute_alpha { keyValue?: string; } /** - * A persistent disk snapshot resource. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) + * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) */ export interface Schema$Snapshot { /** @@ -10508,7 +10991,7 @@ export namespace compute_alpha { */ selfLinkWithId?: string; /** - * Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. + * Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. */ snapshotEncryptionKey?: Schema$CustomerEncryptionKey; /** @@ -10573,6 +11056,16 @@ export namespace compute_alpha { message?: string; }; } + export interface Schema$SourceDiskEncryptionKey { + /** + * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. + */ + diskEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * URL of the disk attached to the source instance. This can be a full or valid partial URL. 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; + } /** * A specification of the parameters to use when creating the instance template from a source instance. */ @@ -10588,7 +11081,7 @@ export namespace compute_alpha { */ canIpForward?: boolean; /** - * Whether the instance created from the machine image should be protected against deletion. + * Whether the instance created from this machine image should be protected against deletion. */ deletionProtection?: boolean; /** @@ -10600,7 +11093,7 @@ export namespace compute_alpha { */ disks?: Schema$SavedAttachedDisk[]; /** - * A list of guest accelerator cards' type and count to use for instances created from the machine image. + * A list of guest accelerator cards' type and count to use for instances created from this machine image. */ guestAccelerators?: Schema$AcceleratorConfig[]; /** @@ -10616,7 +11109,7 @@ export namespace compute_alpha { */ metadata?: Schema$Metadata; /** - * Minimum cpu/platform to be used by this instance. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. + * Minimum cpu/platform to be used by instances created from this machine image. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. */ minCpuPlatform?: string; /** @@ -10637,7 +11130,7 @@ export namespace compute_alpha { tags?: Schema$Tags; } /** - * An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) + * Represents an SSL Certificate resource. This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) */ export interface Schema$SslCertificate { /** @@ -10868,7 +11361,7 @@ export namespace compute_alpha { features?: string[]; } /** - * A SSL policy specifies the server-side support for SSL features. This can be attached to a TargetHttpsProxy or a TargetSslProxy. This affects connections between clients and the HTTPS or SSL proxy load balancer. They do not affect the connection between the load balancers and the backends. + * Represents a Cloud Armor Security Policy resource. Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for beta.sslPolicies ==) (== resource_for v1.sslPolicies ==) */ export interface Schema$SslPolicy { /** @@ -10939,30 +11432,14 @@ export namespace compute_alpha { sslPolicy?: string; } export interface Schema$StatefulPolicy { - preservedResources?: Schema$StatefulPolicyPreservedResources; preservedState?: Schema$StatefulPolicyPreservedState; } - export interface Schema$StatefulPolicyPreservedDisk { - /** - * Device name of the disk to be preserved - */ - deviceName?: string; - } - /** - * Configuration of all preserved resources. - */ - export interface Schema$StatefulPolicyPreservedResources { - /** - * Disks created on the instances that will be preserved on instance delete, resize down, etc. - */ - disks?: Schema$StatefulPolicyPreservedDisk[]; - } /** * Configuration of preserved resources. */ export interface Schema$StatefulPolicyPreservedState { /** - * Disks created on the instances that will be preserved on instance delete, resize down, etc. This map is keyed with the device names of the disks. + * Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks. */ disks?: {[key: string]: Schema$StatefulPolicyPreservedStateDiskDevice}; } @@ -10973,11 +11450,11 @@ export namespace compute_alpha { autoDelete?: string; } /** - * A Subnetwork resource. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==) + * Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== 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. + * Can only be specified if VPC flow logging for this subnetwork is enabled. Sets the aggregation interval for collecting flow logs. Increasing the interval time reduces the amount of generated flow logs for long-lasting connections. Default is an interval of 5 seconds per connection. Valid values: INTERVAL_5_SEC, INTERVAL_30_SEC, INTERVAL_1_MIN, INTERVAL_5_MIN, INTERVAL_10_MIN, INTERVAL_15_MIN. */ aggregationInterval?: string; /** @@ -11005,7 +11482,7 @@ export namespace compute_alpha { */ 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. + * 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; /** @@ -11029,7 +11506,7 @@ export namespace compute_alpha { */ kind?: string; /** - * This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. + * This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Stackdriver. */ logConfig?: Schema$SubnetworkLogConfig; /** @@ -11052,6 +11529,10 @@ export namespace compute_alpha { * The private IPv6 google access type for the VMs in this subnet. This is an expanded field of enablePrivateV6Access. If both fields are set, privateIpv6GoogleAccess will take priority. This field can be both set at resource creation time and updated using patch. */ privateIpv6GoogleAccess?: string; + /** + * The service accounts can be used to selectively turn on Private IPv6 Google Access only on the VMs primary service account matching the value. This value only takes effect when PrivateIpv6GoogleAccess is ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE_FOR_SERVICE_ACCOUNTS or ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE_FOR_SERVICE_ACCOUNTS. + */ + privateIpv6GoogleAccessServiceAccounts?: string[]; /** * The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. */ @@ -11161,11 +11642,11 @@ export namespace compute_alpha { */ enable?: boolean; /** - * 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. + * 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; /** - * 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. + * Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is INCLUDE_ALL_METADATA. */ metadata?: string; } @@ -11241,7 +11722,7 @@ export namespace compute_alpha { }; } /** - * A TargetHttpProxy resource. This resource defines an HTTP proxy. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) + * Represents a Target HTTP Proxy resource. A target HTTP proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) */ export interface Schema$TargetHttpProxy { /** @@ -11375,7 +11856,7 @@ export namespace compute_alpha { sslCertificates?: string[]; } /** - * A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) + * Represents a Target HTTPS Proxy resource. A target HTTPS proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) */ export interface Schema$TargetHttpsProxy { /** @@ -11495,7 +11976,7 @@ export namespace compute_alpha { }; } /** - * A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) + * Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) */ export interface Schema$TargetInstance { /** @@ -11617,7 +12098,7 @@ export namespace compute_alpha { }; } /** - * A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) + * Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) */ export interface Schema$TargetPool { /** @@ -11803,7 +12284,7 @@ export namespace compute_alpha { sslCertificates?: string[]; } /** - * A TargetSslProxy resource. This resource defines an SSL proxy. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) + * Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) */ export interface Schema$TargetSslProxy { /** @@ -11893,7 +12374,7 @@ export namespace compute_alpha { proxyHeader?: string; } /** - * A TargetTcpProxy resource. This resource defines a TCP proxy. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) + * Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference ta target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing Concepts. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) */ export interface Schema$TargetTcpProxy { /** @@ -11963,7 +12444,7 @@ export namespace compute_alpha { }; } /** - * Represents a Target VPN gateway resource. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) + * Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) */ export interface Schema$TargetVpnGateway { /** @@ -12219,7 +12700,7 @@ export namespace compute_alpha { response?: string; } /** - * A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. + * Represents a URL Map resource. A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts. */ export interface Schema$UrlMap { /** @@ -12778,7 +13259,7 @@ export namespace compute_alpha { ipAddress?: string; } /** - * VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) + * Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) */ export interface Schema$VpnTunnel { /** @@ -13036,7 +13517,7 @@ export namespace compute_alpha { type?: string; } /** - * A Zone resource. (== resource_for beta.zones ==) (== resource_for v1.zones ==) Next ID: 17 + * Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones. (== resource_for beta.zones ==) (== resource_for v1.zones ==) */ export interface Schema$Zone { /** @@ -13202,7 +13683,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -13283,7 +13764,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -13362,7 +13843,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -13532,7 +14013,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -13607,7 +14088,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -13680,7 +14161,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -13706,7 +14187,7 @@ export namespace compute_alpha { /** * compute.addresses.insert - * @desc Creates an address resource in the specified project using the data included in the request. + * @desc Creates an address resource in the specified project by using the data included in the request. * @alias compute.addresses.insert * @memberOf! () * @@ -13756,7 +14237,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -13834,7 +14315,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -13912,7 +14393,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -13993,7 +14474,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -14262,7 +14743,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -14339,7 +14820,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -14414,7 +14895,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -14491,7 +14972,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -14569,7 +15050,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -14647,7 +15128,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -14728,7 +15209,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -14806,7 +15287,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15101,7 +15582,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15177,7 +15658,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15254,7 +15735,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15329,7 +15810,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15402,7 +15883,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15478,7 +15959,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15556,7 +16037,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15633,7 +16114,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15707,7 +16188,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15787,7 +16268,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15864,7 +16345,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16191,7 +16672,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16273,7 +16754,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16354,7 +16835,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16431,7 +16912,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16506,7 +16987,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16586,7 +17067,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16665,7 +17146,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16743,7 +17224,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16820,7 +17301,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16897,7 +17378,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16977,7 +17458,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -17054,7 +17535,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -17419,7 +17900,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -17499,7 +17980,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -17530,7 +18011,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.disk Name of the persistent disk to snapshot. - * @param {boolean=} params.guestFlush + * @param {boolean=} params.guestFlush [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). * @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. @@ -17577,7 +18058,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -17653,7 +18134,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -17726,7 +18207,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -17800,7 +18281,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -17877,7 +18358,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -17952,7 +18433,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -18031,7 +18512,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -18108,7 +18589,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -18183,7 +18664,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -18260,7 +18741,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -18341,7 +18822,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -18435,7 +18916,7 @@ export namespace compute_alpha { */ disk?: string; /** - * + * [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). */ guestFlush?: boolean; /** @@ -18777,7 +19258,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -18849,7 +19330,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -18927,7 +19408,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19089,7 +19570,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19164,7 +19645,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19240,7 +19721,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19320,7 +19801,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19396,7 +19877,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19476,7 +19957,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19686,7 +20167,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19758,7 +20239,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19833,7 +20314,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19909,7 +20390,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19984,7 +20465,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -20064,7 +20545,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -20140,7 +20621,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -20380,7 +20861,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -20462,7 +20943,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -20538,7 +21019,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -20615,7 +21096,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -20694,7 +21175,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -20772,7 +21253,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -20850,7 +21331,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -20928,7 +21409,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -21009,7 +21490,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -21334,7 +21815,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -21407,7 +21888,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -21433,7 +21914,7 @@ export namespace compute_alpha { /** * compute.globalAddresses.insert - * @desc Creates an address resource in the specified project using the data included in the request. + * @desc Creates an address resource in the specified project by using the data included in the request. * @alias compute.globalAddresses.insert * @memberOf! () * @@ -21483,7 +21964,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -21560,7 +22041,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -21635,7 +22116,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -21715,7 +22196,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -21926,7 +22407,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22001,7 +22482,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22077,7 +22558,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22155,7 +22636,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22232,7 +22713,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22308,7 +22789,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22385,7 +22866,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22465,7 +22946,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22729,7 +23210,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22805,7 +23286,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22884,7 +23365,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22961,7 +23442,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -23037,7 +23518,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -23117,7 +23598,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -23214,7 +23695,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -23476,7 +23957,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -23549,7 +24030,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -23624,7 +24105,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -23702,7 +24183,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -23776,7 +24257,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -23961,7 +24442,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -24036,7 +24517,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -24114,7 +24595,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -24188,7 +24669,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -24354,7 +24835,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -24433,7 +24914,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -24507,7 +24988,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -24583,7 +25064,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -24660,7 +25141,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -24736,7 +25217,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -24816,7 +25297,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -24893,7 +25374,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -25160,7 +25641,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -25235,7 +25716,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -25311,7 +25792,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -25389,7 +25870,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -25466,7 +25947,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -25546,7 +26027,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -25623,7 +26104,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -25863,7 +26344,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -25938,7 +26419,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26014,7 +26495,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26094,7 +26575,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26171,7 +26652,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26251,7 +26732,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26328,7 +26809,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26567,7 +27048,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26643,7 +27124,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26715,7 +27196,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26788,7 +27269,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26861,7 +27342,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26937,7 +27418,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27013,7 +27494,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27086,7 +27567,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27161,7 +27642,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27241,7 +27722,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27530,7 +28011,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27612,7 +28093,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27696,7 +28177,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27774,7 +28255,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27851,7 +28332,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27929,7 +28410,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28008,7 +28489,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28086,7 +28567,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28163,7 +28644,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28244,7 +28725,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28268,6 +28749,103 @@ export namespace compute_alpha { } } + /** + * compute.instanceGroupManagers.listErrors + * @desc Lists all errors thrown by actions on instances for a given managed instance group. + * @alias compute.instanceGroupManagers.listErrors + * @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 {string} params.instanceGroupManager The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|[1-9][0-9]{0,19}. + * @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 where the managed instance group is located. It should conform to RFC1035. + * @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 + */ + listErrors( + params?: Params$Resource$Instancegroupmanagers$Listerrors, + options?: MethodOptions + ): GaxiosPromise; + listErrors( + params: Params$Resource$Instancegroupmanagers$Listerrors, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$InstanceGroupManagersListErrorsResponse + > + ): void; + listErrors( + params: Params$Resource$Instancegroupmanagers$Listerrors, + callback: BodyResponseCallback< + Schema$InstanceGroupManagersListErrorsResponse + > + ): void; + listErrors( + callback: BodyResponseCallback< + Schema$InstanceGroupManagersListErrorsResponse + > + ): void; + listErrors( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Listerrors + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$InstanceGroupManagersListErrorsResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Listerrors; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Listerrors; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * compute.instanceGroupManagers.listManagedInstances * @desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. @@ -28344,7 +28922,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28448,7 +29026,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28530,7 +29108,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28610,7 +29188,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28688,7 +29266,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28766,7 +29344,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28844,7 +29422,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28924,7 +29502,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -29002,7 +29580,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -29080,7 +29658,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -29161,7 +29739,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -29239,7 +29817,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -29319,7 +29897,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -29610,6 +30188,42 @@ export namespace compute_alpha { */ zone?: string; } + export interface Params$Resource$Instancegroupmanagers$Listerrors + extends StandardParameters { + /** + * 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 name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|[1-9][0-9]{0,19}. + */ + 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. + */ + 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 where the managed instance group is located. It should conform to RFC1035. + */ + zone?: string; + } export interface Params$Resource$Instancegroupmanagers$Listmanagedinstances extends StandardParameters { /** @@ -30057,7 +30671,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -30139,7 +30753,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -30219,7 +30833,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -30295,7 +30909,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -30372,7 +30986,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -30451,7 +31065,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -30536,7 +31150,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -30617,7 +31231,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -30695,7 +31309,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -30776,7 +31390,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -31145,7 +31759,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -31223,7 +31837,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -31305,7 +31919,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -31383,7 +31997,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -31459,7 +32073,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -31538,7 +32152,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -31622,7 +32236,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -31695,7 +32309,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -31784,7 +32398,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -31869,7 +32483,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -31943,7 +32557,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32023,7 +32637,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32103,7 +32717,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32181,7 +32795,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32259,7 +32873,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32337,7 +32951,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32421,7 +33035,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32501,7 +33115,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32577,7 +33191,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32654,7 +33268,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32734,7 +33348,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32813,7 +33427,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32894,7 +33508,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32972,7 +33586,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33050,7 +33664,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33128,7 +33742,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33206,7 +33820,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33284,7 +33898,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33308,6 +33922,84 @@ export namespace compute_alpha { } } + /** + * compute.instances.setName + * @desc Sets name of an instance. + * @alias compute.instances.setName + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance The instance 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 {().InstancesSetNameRequest} 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 + */ + setName( + params?: Params$Resource$Instances$Setname, + options?: MethodOptions + ): GaxiosPromise; + setName( + params: Params$Resource$Instances$Setname, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setName( + params: Params$Resource$Instances$Setname, + callback: BodyResponseCallback + ): void; + setName(callback: BodyResponseCallback): void; + setName( + paramsOrCallback?: + | Params$Resource$Instances$Setname + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Setname; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Setname; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/setName' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.instances.setScheduling * @desc Sets an instance's scheduling options. @@ -33362,7 +34054,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33440,7 +34132,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33520,7 +34212,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33600,7 +34292,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33678,7 +34370,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33756,7 +34448,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33832,7 +34524,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33912,7 +34604,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33989,7 +34681,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -34067,7 +34759,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -34148,7 +34840,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -34227,7 +34919,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -34305,7 +34997,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -34386,7 +35078,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -34466,7 +35158,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -34546,7 +35238,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -35345,7 +36037,7 @@ export namespace compute_alpha { */ requestBody?: Schema$InstancesSetMinCpuPlatformRequest; } - export interface Params$Resource$Instances$Setscheduling + export interface Params$Resource$Instances$Setname extends StandardParameters { /** * Auth client or API Key for the request @@ -35353,7 +36045,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Instance name for this request. + * The instance name for this request. */ instance?: string; /** @@ -35372,9 +36064,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$Scheduling; + requestBody?: Schema$InstancesSetNameRequest; } - export interface Params$Resource$Instances$Setserviceaccount + export interface Params$Resource$Instances$Setscheduling extends StandardParameters { /** * Auth client or API Key for the request @@ -35382,7 +36074,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the instance resource to start. + * Instance name for this request. */ instance?: string; /** @@ -35401,9 +36093,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$InstancesSetServiceAccountRequest; + requestBody?: Schema$Scheduling; } - export interface Params$Resource$Instances$Setshieldedinstanceintegritypolicy + export interface Params$Resource$Instances$Setserviceaccount extends StandardParameters { /** * Auth client or API Key for the request @@ -35411,7 +36103,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name or id of the instance scoping this request. + * Name of the instance resource to start. */ instance?: string; /** @@ -35430,9 +36122,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$ShieldedInstanceIntegrityPolicy; + requestBody?: Schema$InstancesSetServiceAccountRequest; } - export interface Params$Resource$Instances$Setshieldedvmintegritypolicy + export interface Params$Resource$Instances$Setshieldedinstanceintegritypolicy extends StandardParameters { /** * Auth client or API Key for the request @@ -35440,7 +36132,7 @@ export namespace compute_alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the instance scoping this request. + * Name or id of the instance scoping this request. */ instance?: string; /** @@ -35459,9 +36151,38 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$ShieldedVmIntegrityPolicy; + requestBody?: Schema$ShieldedInstanceIntegrityPolicy; } - export interface Params$Resource$Instances$Settags + export interface Params$Resource$Instances$Setshieldedvmintegritypolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: 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$ShieldedVmIntegrityPolicy; + } + export interface Params$Resource$Instances$Settags extends StandardParameters { /** * Auth client or API Key for the request @@ -35854,7 +36575,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -35929,7 +36650,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36002,7 +36723,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36078,7 +36799,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36158,7 +36879,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36232,7 +36953,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36312,7 +37033,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36553,7 +37274,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36635,7 +37356,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36713,7 +37434,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36787,7 +37508,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36821,6 +37542,7 @@ export namespace compute_alpha { * @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 {boolean=} params.validateOnly If true, the request will not be committed. * @param {().InterconnectAttachment} 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. @@ -36864,7 +37586,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36947,7 +37669,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37028,7 +37750,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37103,7 +37825,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37181,7 +37903,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37262,7 +37984,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37398,6 +38120,10 @@ export namespace compute_alpha { * 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; + /** + * If true, the request will not be committed. + */ + validateOnly?: boolean; /** * Request body metadata @@ -37604,7 +38330,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37684,7 +38410,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37764,7 +38490,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37913,7 +38639,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37988,7 +38714,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38069,7 +38795,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38147,7 +38873,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38223,7 +38949,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38300,7 +39026,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38376,7 +39102,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38450,7 +39176,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38526,7 +39252,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38606,7 +39332,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38893,7 +39619,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38966,7 +39692,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -39040,7 +39766,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -39120,7 +39846,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -39276,7 +40002,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -39348,7 +40074,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -39421,7 +40147,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -39496,7 +40222,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -39574,7 +40300,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -39647,7 +40373,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -39727,7 +40453,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -39950,7 +40676,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40025,7 +40751,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40098,7 +40824,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40175,7 +40901,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40252,7 +40978,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40325,7 +41051,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40405,7 +41131,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40642,7 +41368,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40720,7 +41446,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40799,7 +41525,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40968,7 +41694,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -41053,7 +41779,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -41130,7 +41856,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -41210,7 +41936,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -41288,7 +42014,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -41365,7 +42091,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -41446,7 +42172,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -41545,7 +42271,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -41631,7 +42357,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -41969,7 +42695,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42044,7 +42770,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42116,7 +42842,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42203,7 +42929,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42283,7 +43009,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42359,7 +43085,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42440,7 +43166,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42524,7 +43250,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42610,7 +43336,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42689,7 +43415,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42766,7 +43492,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42842,7 +43568,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42922,7 +43648,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42999,7 +43725,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -43454,7 +44180,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -43536,7 +44262,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -43613,7 +44339,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -43691,7 +44417,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -43766,7 +44492,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -43840,7 +44566,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -43918,7 +44644,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -43996,7 +44722,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -44076,7 +44802,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -44156,7 +44882,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -44231,7 +44957,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -44309,7 +45035,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -44390,7 +45116,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -44833,7 +45559,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -44913,7 +45639,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -44989,7 +45715,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -45063,7 +45789,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -45140,7 +45866,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -45219,7 +45945,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -45294,7 +46020,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -45375,7 +46101,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -45664,7 +46390,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -45736,7 +46462,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -45814,7 +46540,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -45977,7 +46703,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46053,7 +46779,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46129,7 +46855,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46204,7 +46930,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46278,7 +47004,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46357,7 +47083,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46435,7 +47161,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46511,7 +47237,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46589,7 +47315,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46685,7 +47411,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46765,7 +47491,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46841,7 +47567,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46918,7 +47644,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46994,7 +47720,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47070,7 +47796,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47389,6 +48115,752 @@ export namespace compute_alpha { securityPolicy?: string; } + export class Resource$Packetmirrorings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.packetMirrorings.aggregatedList + * @desc Retrieves an aggregated list of packetMirrorings. + * @alias compute.packetMirrorings.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$Packetmirrorings$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Packetmirrorings$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Packetmirrorings$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/packetMirrorings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.packetMirrorings.delete + * @desc Deletes the specified PacketMirroring resource. + * @alias compute.packetMirrorings.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packetMirroring Name of the PacketMirroring resource to delete. + * @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 {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$Packetmirrorings$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Packetmirrorings$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Packetmirrorings$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'packetMirroring'], + pathParams: ['packetMirroring', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.packetMirrorings.get + * @desc Returns the specified PacketMirroring resource. + * @alias compute.packetMirrorings.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packetMirroring Name of the PacketMirroring resource to return. + * @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 + */ + get( + params?: Params$Resource$Packetmirrorings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Packetmirrorings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Packetmirrorings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'packetMirroring'], + pathParams: ['packetMirroring', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.packetMirrorings.insert + * @desc Creates a PacketMirroring resource in the specified project and region using the data included in the request. + * @alias compute.packetMirrorings.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 {().PacketMirroring} 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$Packetmirrorings$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Packetmirrorings$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Packetmirrorings$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.packetMirrorings.list + * @desc Retrieves a list of PacketMirroring resources available to the specified project and region. + * @alias compute.packetMirrorings.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$Packetmirrorings$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Packetmirrorings$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Packetmirrorings$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.packetMirrorings.patch + * @desc Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * @alias compute.packetMirrorings.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packetMirroring Name of the PacketMirroring resource to patch. + * @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 {().PacketMirroring} 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$Packetmirrorings$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Packetmirrorings$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Packetmirrorings$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'packetMirroring'], + pathParams: ['packetMirroring', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.packetMirrorings.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.packetMirrorings.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 or id 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$Packetmirrorings$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Packetmirrorings$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Packetmirrorings$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Packetmirrorings$Aggregatedlist + extends StandardParameters { + /** + * 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$Packetmirrorings$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the PacketMirroring resource to delete. + */ + packetMirroring?: string; + /** + * 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; + } + export interface Params$Resource$Packetmirrorings$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the PacketMirroring resource to return. + */ + packetMirroring?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Packetmirrorings$Insert + extends StandardParameters { + /** + * 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$PacketMirroring; + } + export interface Params$Resource$Packetmirrorings$List + extends StandardParameters { + /** + * 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$Packetmirrorings$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the PacketMirroring resource to patch. + */ + packetMirroring?: string; + /** + * 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$PacketMirroring; + } + export interface Params$Resource$Packetmirrorings$Testiampermissions + extends StandardParameters { + /** + * 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 or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export class Resource$Projects { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -47446,7 +48918,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47471,7 +48943,7 @@ export namespace compute_alpha { /** * compute.projects.disableXpnResource - * @desc Disable a serivce resource (a.k.a service project) associated with this host project. + * @desc Disable a service resource (also known as service project) associated with this host project. * @alias compute.projects.disableXpnResource * @memberOf! () * @@ -47521,7 +48993,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47595,7 +49067,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47670,7 +49142,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47740,7 +49212,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47812,7 +49284,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47893,7 +49365,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47971,7 +49443,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48046,7 +49518,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48121,7 +49593,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48198,7 +49670,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48276,7 +49748,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48354,7 +49826,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48432,7 +49904,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48800,7 +50272,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48876,7 +50348,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48953,7 +50425,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49034,7 +50506,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49112,7 +50584,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49193,7 +50665,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49271,7 +50743,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49540,7 +51012,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49616,7 +51088,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49697,7 +51169,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49777,7 +51249,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49856,7 +51328,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49934,7 +51406,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -50015,7 +51487,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -50093,7 +51565,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -50392,7 +51864,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -50468,7 +51940,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -50545,7 +52017,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -50624,7 +52096,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -50705,7 +52177,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -50783,7 +52255,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51028,7 +52500,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51060,7 +52532,7 @@ export namespace compute_alpha { * * @param {object} params Parameters for request * @param {string} params.disk Name of the regional persistent disk to snapshot. - * @param {boolean=} params.guestFlush + * @param {boolean=} params.guestFlush [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). * @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). @@ -51107,7 +52579,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51184,7 +52656,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51257,7 +52729,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51331,7 +52803,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51409,7 +52881,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51485,7 +52957,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51565,7 +53037,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51643,7 +53115,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51718,7 +53190,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51796,7 +53268,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51877,7 +53349,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51943,7 +53415,7 @@ export namespace compute_alpha { */ disk?: string; /** - * + * [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). */ guestFlush?: boolean; /** @@ -52281,7 +53753,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -52360,7 +53832,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -52497,7 +53969,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -52573,7 +54045,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -52650,7 +54122,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -52729,7 +54201,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -52807,7 +54279,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -52888,7 +54360,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -52966,7 +54438,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -53235,7 +54707,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -53311,7 +54783,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -53388,7 +54860,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -53469,7 +54941,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -53550,7 +55022,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -53762,7 +55234,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -53841,7 +55313,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -53919,7 +55391,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -53996,7 +55468,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54074,7 +55546,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54153,7 +55625,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54231,7 +55703,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54308,7 +55780,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54391,7 +55863,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54420,6 +55892,111 @@ export namespace compute_alpha { } } + /** + * compute.regionInstanceGroupManagers.listErrors + * @desc Lists all errors thrown by actions on instances for a given regional managed instance group. + * @alias compute.regionInstanceGroupManagers.listErrors + * @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 {string} params.instanceGroupManager The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|[1-9][0-9]{0,19}. + * @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. This should conform to RFC1035. + * @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 + */ + listErrors( + params?: Params$Resource$Regioninstancegroupmanagers$Listerrors, + options?: MethodOptions + ): GaxiosPromise; + listErrors( + params: Params$Resource$Regioninstancegroupmanagers$Listerrors, + options: + | MethodOptions + | BodyResponseCallback< + Schema$RegionInstanceGroupManagersListErrorsResponse + >, + callback: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListErrorsResponse + > + ): void; + listErrors( + params: Params$Resource$Regioninstancegroupmanagers$Listerrors, + callback: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListErrorsResponse + > + ): void; + listErrors( + callback: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListErrorsResponse + > + ): void; + listErrors( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Listerrors + | BodyResponseCallback< + Schema$RegionInstanceGroupManagersListErrorsResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$RegionInstanceGroupManagersListErrorsResponse + >, + callback?: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListErrorsResponse + > + ): void | GaxiosPromise< + Schema$RegionInstanceGroupManagersListErrorsResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Listerrors; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Listerrors; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$RegionInstanceGroupManagersListErrorsResponse + >(parameters); + } + } + /** * compute.regionInstanceGroupManagers.listManagedInstances * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. @@ -54496,7 +56073,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54600,7 +56177,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54682,7 +56259,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54762,7 +56339,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54840,7 +56417,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54918,7 +56495,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54998,7 +56575,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55076,7 +56653,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55154,7 +56731,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55235,7 +56812,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55313,7 +56890,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55393,7 +56970,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55656,6 +57233,42 @@ export namespace compute_alpha { */ region?: string; } + export interface Params$Resource$Regioninstancegroupmanagers$Listerrors + extends StandardParameters { + /** + * 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 name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|[1-9][0-9]{0,19}. + */ + 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. + */ + 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. This should conform to RFC1035. + */ + region?: string; + } export interface Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances extends StandardParameters { /** @@ -56072,7 +57685,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -56153,7 +57766,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -56238,7 +57851,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -56321,7 +57934,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -56402,7 +58015,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -56634,7 +58247,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -56712,7 +58325,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -56789,7 +58402,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -56870,7 +58483,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -56951,7 +58564,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -57159,7 +58772,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -57235,7 +58848,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -57314,7 +58927,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -57390,7 +59003,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -57562,7 +59175,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -57638,7 +59251,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -57764,7 +59377,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -57840,7 +59453,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -57917,7 +59530,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -57996,7 +59609,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -58077,7 +59690,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -58288,7 +59901,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -58364,7 +59977,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -58441,7 +60054,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -58520,7 +60133,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -58598,7 +60211,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -58679,7 +60292,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -58919,7 +60532,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -58995,7 +60608,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -59072,7 +60685,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -59153,7 +60766,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -59231,7 +60844,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -59309,7 +60922,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -59390,7 +61003,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -59659,7 +61272,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -59733,7 +61346,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -59810,7 +61423,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -59888,7 +61501,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -59967,7 +61580,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -60045,7 +61658,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -60126,7 +61739,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -60204,7 +61817,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -60285,7 +61898,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -60613,7 +62226,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -60693,7 +62306,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -60768,7 +62381,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -60842,7 +62455,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -60868,7 +62481,7 @@ export namespace compute_alpha { /** * compute.reservations.insert - * @desc Creates a new reservation. + * @desc Creates a new reservation. For more information, read Reserving zonal resources. * @alias compute.reservations.insert * @memberOf! () * @@ -60919,7 +62532,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -60998,7 +62611,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61076,7 +62689,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61151,7 +62764,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61232,7 +62845,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61549,7 +63162,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61631,7 +63244,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61707,7 +63320,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61781,7 +63394,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61858,7 +63471,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61937,7 +63550,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62012,7 +63625,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62093,7 +63706,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62382,7 +63995,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62457,7 +64070,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62530,7 +64143,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62615,7 +64228,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62698,7 +64311,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62774,7 +64387,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62852,7 +64465,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62929,7 +64542,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -63009,7 +64622,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -63090,7 +64703,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -63116,7 +64729,7 @@ export namespace compute_alpha { /** * compute.routers.update - * @desc Updates the specified Router resource with the data included in the request. + * @desc Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. * @alias compute.routers.update * @memberOf! () * @@ -63167,7 +64780,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -63540,7 +65153,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -63612,7 +65225,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -63687,7 +65300,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -63763,7 +65376,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -63842,7 +65455,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64029,7 +65642,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64105,7 +65718,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64180,7 +65793,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64256,7 +65869,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64333,7 +65946,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64411,7 +66024,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64511,7 +66124,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64592,7 +66205,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64670,7 +66283,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64746,7 +66359,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64822,7 +66435,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64902,7 +66515,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65263,7 +66876,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65335,7 +66948,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65408,7 +67021,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65485,7 +67098,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65558,7 +67171,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65634,7 +67247,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65714,7 +67327,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65944,7 +67557,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66025,7 +67638,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66100,7 +67713,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66176,7 +67789,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66254,7 +67867,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66334,7 +67947,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66552,7 +68165,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66626,7 +68239,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66702,7 +68315,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66778,7 +68391,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66867,7 +68480,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66949,7 +68562,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67029,7 +68642,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67276,7 +68889,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67353,7 +68966,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67431,7 +69044,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67506,7 +69119,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67580,7 +69193,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67657,7 +69270,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67735,7 +69348,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67817,7 +69430,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67901,7 +69514,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67976,7 +69589,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -68056,7 +69669,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -68137,7 +69750,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -68543,7 +70156,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -68624,7 +70237,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -68699,7 +70312,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -68775,7 +70388,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -68853,7 +70466,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -68930,7 +70543,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69010,7 +70623,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69259,7 +70872,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69340,7 +70953,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69415,7 +71028,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69491,7 +71104,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69571,7 +71184,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69648,7 +71261,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69725,7 +71338,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69802,7 +71415,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69879,7 +71492,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69959,7 +71572,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -70283,7 +71896,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -70365,7 +71978,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -70441,7 +72054,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -70518,7 +72131,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -70597,7 +72210,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -70678,7 +72291,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -70918,7 +72531,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -70996,7 +72609,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71078,7 +72691,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71155,7 +72768,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71230,7 +72843,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71311,7 +72924,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71388,7 +73001,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71466,7 +73079,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71544,7 +73157,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71622,7 +73235,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71701,7 +73314,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71782,7 +73395,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72192,7 +73805,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72267,7 +73880,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72343,7 +73956,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72421,7 +74034,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72498,7 +74111,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72575,7 +74188,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72652,7 +74265,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72729,7 +74342,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72809,7 +74422,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -73099,7 +74712,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -73174,7 +74787,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -73250,7 +74863,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -73328,7 +74941,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -73405,7 +75018,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -73482,7 +75095,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -73562,7 +75175,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -73808,7 +75421,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -73890,7 +75503,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -73966,7 +75579,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74043,7 +75656,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74124,7 +75737,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74202,7 +75815,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74283,7 +75896,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74556,7 +76169,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74630,7 +76243,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74702,7 +76315,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74777,7 +76390,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74853,7 +76466,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74930,7 +76543,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -75005,7 +76618,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -75085,7 +76698,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -75161,7 +76774,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -75240,7 +76853,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -75553,7 +77166,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -75630,7 +77243,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -75705,7 +77318,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -75785,7 +77398,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -75867,7 +77480,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -75945,7 +77558,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -76023,7 +77636,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -76104,7 +77717,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -76395,7 +78008,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -76472,7 +78085,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -76547,7 +78160,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -76624,7 +78237,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -76702,7 +78315,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -76780,7 +78393,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -76861,7 +78474,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -77124,7 +78737,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -77200,7 +78813,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -77279,7 +78892,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -77355,7 +78968,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -77527,7 +79140,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -77601,7 +79214,7 @@ export namespace compute_alpha { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index efba5a387bc..3cd048a3fc0 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -127,10 +127,15 @@ export namespace compute_beta { regionCommitments: Resource$Regioncommitments; regionDisks: Resource$Regiondisks; regionDiskTypes: Resource$Regiondisktypes; + regionHealthChecks: Resource$Regionhealthchecks; regionInstanceGroupManagers: Resource$Regioninstancegroupmanagers; regionInstanceGroups: Resource$Regioninstancegroups; regionOperations: Resource$Regionoperations; regions: Resource$Regions; + regionSslCertificates: Resource$Regionsslcertificates; + regionTargetHttpProxies: Resource$Regiontargethttpproxies; + regionTargetHttpsProxies: Resource$Regiontargethttpsproxies; + regionUrlMaps: Resource$Regionurlmaps; reservations: Resource$Reservations; resourcePolicies: Resource$Resourcepolicies; routers: Resource$Routers; @@ -209,6 +214,7 @@ export namespace compute_beta { this.regionCommitments = new Resource$Regioncommitments(this.context); this.regionDisks = new Resource$Regiondisks(this.context); this.regionDiskTypes = new Resource$Regiondisktypes(this.context); + this.regionHealthChecks = new Resource$Regionhealthchecks(this.context); this.regionInstanceGroupManagers = new Resource$Regioninstancegroupmanagers( this.context ); @@ -217,6 +223,16 @@ export namespace compute_beta { ); this.regionOperations = new Resource$Regionoperations(this.context); this.regions = new Resource$Regions(this.context); + this.regionSslCertificates = new Resource$Regionsslcertificates( + this.context + ); + this.regionTargetHttpProxies = new Resource$Regiontargethttpproxies( + this.context + ); + this.regionTargetHttpsProxies = new Resource$Regiontargethttpsproxies( + this.context + ); + this.regionUrlMaps = new Resource$Regionurlmaps(this.context); this.reservations = new Resource$Reservations(this.context); this.resourcePolicies = new Resource$Resourcepolicies(this.context); this.routers = new Resource$Routers(this.context); @@ -255,7 +271,7 @@ export namespace compute_beta { acceleratorType?: string; } /** - * An Accelerator Type resource. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==) + * Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==) */ export interface Schema$AcceleratorType { /** @@ -381,7 +397,7 @@ export namespace compute_beta { */ kind?: string; /** - * The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. + * The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. */ name?: string; /** @@ -393,11 +409,11 @@ export namespace compute_beta { */ 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. + * The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled. */ publicPtrDomainName?: string; /** - * Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name. + * Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. */ setPublicPtr?: boolean; /** @@ -406,7 +422,7 @@ export namespace compute_beta { type?: string; } /** - * A reserved address resource. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==) + * Represents an IP Address resource. An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses. A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==) */ export interface Schema$Address { /** @@ -422,7 +438,7 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you create the resource. + * An optional description of this resource. Provide this field when you create the resource. */ description?: string; /** @@ -430,7 +446,7 @@ export namespace compute_beta { */ id?: string; /** - * The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. + * The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. */ ipVersion?: string; /** @@ -446,15 +462,15 @@ export namespace compute_beta { */ labels?: {[key: string]: 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 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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. */ name?: string; /** - * The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with VPC_PEERING purpose. + * The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose. */ network?: string; /** - * This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM, STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a Network load balancer. If this field is not specified, it is assumed to be PREMIUM. + * This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer. If this field is not specified, it is assumed to be PREMIUM. */ networkTier?: string; /** @@ -462,11 +478,11 @@ export namespace compute_beta { */ prefixLength?: number; /** - * The purpose of resource, only used with INTERNAL type. + * The purpose of this resource, which can be one of the following values: - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. - `DNS_RESOLVER` for a DNS resolver address in a subnetwork - `VPC_PEERING` for addresses that are reserved for VPC peer networks. - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT. */ purpose?: 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 as part of the HTTP request URL. You cannot set this field in the request body. + * [Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL. */ region?: string; /** @@ -478,7 +494,7 @@ export namespace compute_beta { */ status?: string; /** - * The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. + * The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose. */ subnetwork?: string; /** @@ -568,11 +584,11 @@ export namespace compute_beta { */ export interface Schema$AliasIpRange { /** - * The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24). + * The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24). */ ipCidrRange?: string; /** - * Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. + * The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. */ subnetworkRangeName?: string; } @@ -657,7 +673,7 @@ export namespace compute_beta { */ initializeParams?: Schema$AttachedDiskInitializeParams; /** - * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. + * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. TODO(b/131765817): Update documentation when NVME is supported. */ interface?: string; /** @@ -767,7 +783,7 @@ export namespace compute_beta { permissionType?: string; } /** - * Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==) + * Represents an Autoscaler resource. Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==) */ export interface Schema$Autoscaler { /** @@ -983,7 +999,7 @@ export namespace compute_beta { */ export interface Schema$Backend { /** - * Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). For Internal Load Balancing, the default and only supported mode is CONNECTION. + * Specifies the balancing mode for the backend. When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG). - If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle. The CONNECTION balancing mode is only available if the protocol for the backend service is SSL, TCP, or UDP. If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters. - If the load balancing mode is RATE, then the load is spread based on the rate of HTTP requests per second (RPS). The RATE balancing mode is only available if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate, maxRatePerInstance, or maxRatePerEndpoint. - If the load balancing mode is UTILIZATION, then the load is spread based on the CPU utilization of instances in an instance group. The UTILIZATION balancing mode is only available if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backend is made up of instance groups. There are no restrictions on the backend service protocol. */ balancingMode?: string; /** @@ -999,19 +1015,19 @@ export namespace compute_beta { */ failover?: boolean; /** - * The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group. Backend service can not contain mix of Instance Group and Network Endpoint Group backends. Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL. When the BackendService has load balancing scheme INTERNAL, the instance group must be within the same region as the BackendService. Network Endpoint Groups are not supported for INTERNAL load balancing scheme. + * The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme. - When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. - When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. */ group?: string; /** - * The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing. + * Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION. */ maxConnections?: number; /** - * The max number of simultaneous connections that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set. This cannot be used for internal load balancing. + * Defines a maximum target for simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION. */ maxConnectionsPerEndpoint?: number; /** - * The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing. + * Defines a maximum target for simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION. */ maxConnectionsPerInstance?: number; /** @@ -1019,20 +1035,20 @@ export namespace compute_beta { */ maxRate?: number; /** - * The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set. This cannot be used for internal load balancing. + * Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerInstance. Not available if the backend's balancingMode is CONNECTION. */ maxRatePerEndpoint?: number; /** - * The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing. + * Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerEndpoint. Not available if the backend's balancingMode is CONNECTION. */ maxRatePerInstance?: number; /** - * Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0]. This cannot be used for internal load balancing. + * Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION. This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections, or maxConnectionsPerInstance. */ maxUtilization?: number; } /** - * A BackendBucket resource. This resource defines a Cloud Storage bucket. + * Represents a Cloud Storage Bucket resource. This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets. */ export interface Schema$BackendBucket { /** @@ -1119,11 +1135,11 @@ export namespace compute_beta { }; } /** - * A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) + * Represents a Backend Service resource. Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services. A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director. A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) */ export interface Schema$BackendService { /** - * Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used. + * If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is one day (86,400). */ affinityCookieTtlSec?: number; /** @@ -1134,7 +1150,15 @@ export namespace compute_beta { * Cloud CDN configuration for this BackendService. */ cdnPolicy?: Schema$BackendServiceCdnPolicy; + /** + * Settings controlling the volume of connections to a backend service. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + */ + circuitBreakers?: Schema$CircuitBreakers; connectionDraining?: Schema$ConnectionDraining; + /** + * Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + */ + consistentHash?: Schema$ConsistentHashLoadBalancerSettings; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -1148,9 +1172,12 @@ export namespace compute_beta { */ description?: string; /** - * If true, enable Cloud CDN for this BackendService. When the load balancing scheme is INTERNAL, this field is not used. + * If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS. */ enableCDN?: boolean; + /** + * Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend. + */ failoverPolicy?: Schema$BackendServiceFailoverPolicy; /** * 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, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService. @@ -1173,6 +1200,10 @@ export namespace compute_beta { * Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL. */ loadBalancingScheme?: string; + /** + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + */ + localityLbPolicy?: string; /** * This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. */ @@ -1182,15 +1213,19 @@ export namespace compute_beta { */ name?: string; /** - * Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. This cannot be used for internal load balancing. + * Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + */ + outlierDetection?: Schema$OutlierDetection; + /** + * Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing). */ port?: number; /** - * Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. When the load balancing scheme is INTERNAL, this field is not used. + * A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Blaancing). */ portName?: string; /** - * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. For internal load balancing, the possible values are TCP and UDP, and the default is TCP. + * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic director for more information. */ protocol?: string; /** @@ -1206,11 +1241,11 @@ export namespace compute_beta { */ selfLink?: string; /** - * Type of session affinity to use. The default is NONE. When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the protocol is UDP, this field is not used. + * Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP. When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. GENERATED_COOKIE is only available if the protocol is HTTP or HTTPS. When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the loadBalancingScheme is INTERNAL_SELF_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE. */ sessionAffinity?: string; /** - * How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. + * The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds. */ timeoutSec?: number; } @@ -1266,15 +1301,15 @@ export namespace compute_beta { } export interface Schema$BackendServiceFailoverPolicy { /** - * On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false. + * This can be set to true only if the protocol is TCP. The default is false. */ disableConnectionDrainOnFailover?: boolean; /** - * This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false. + * Applicable only to Failover for Internal TCP/UDP Load Balancing. If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy. If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. The default is false. */ dropTrafficIfUnhealthy?: boolean; /** - * The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing. + * Applicable only to Failover for Internal TCP/UDP Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. */ failoverRatio?: number; } @@ -1413,7 +1448,36 @@ export namespace compute_beta { queryStringWhitelist?: string[]; } /** - * Represents a Commitment resource. Creating a Commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. Committed use discounts are subject to Google Cloud Platform's Service Specific Terms. By purchasing a committed use discount, you agree to these terms. Committed use discounts will not renew, so you must purchase a new commitment to continue receiving discounts. (== resource_for beta.commitments ==) (== resource_for v1.commitments ==) + * Settings controlling the volume of connections to a backend service. + */ + export interface Schema$CircuitBreakers { + /** + * The timeout for new network connections to hosts. + */ + connectTimeout?: Schema$Duration; + /** + * The maximum number of connections to the backend cluster. If not specified, the default is 1024. + */ + maxConnections?: number; + /** + * The maximum number of pending requests allowed to the backend cluster. If not specified, the default is 1024. + */ + maxPendingRequests?: number; + /** + * The maximum number of parallel requests that allowed to the backend cluster. If not specified, the default is 1024. + */ + maxRequests?: number; + /** + * Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. + */ + maxRequestsPerConnection?: number; + /** + * The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 3. + */ + maxRetries?: number; + } + /** + * Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==) */ export interface Schema$Commitment { /** @@ -1472,6 +1536,10 @@ export namespace compute_beta { * [Output Only] An optional, human-readable explanation of the status. */ statusMessage?: string; + /** + * The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. + */ + type?: string; } export interface Schema$CommitmentAggregatedList { /** @@ -1580,10 +1648,81 @@ export namespace compute_beta { */ export interface Schema$ConnectionDraining { /** - * Time for which instance will be drained (not accept new connections, but still work to finish started). + * The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600]. */ drainingTimeoutSec?: number; } + /** + * This message defines settings for a consistent hash style load balancer. + */ + export interface Schema$ConsistentHashLoadBalancerSettings { + /** + * Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. + */ + httpCookie?: Schema$ConsistentHashLoadBalancerSettingsHttpCookie; + /** + * The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD. + */ + httpHeaderName?: string; + /** + * The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. + */ + minimumRingSize?: string; + } + /** + * The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. + */ + export interface Schema$ConsistentHashLoadBalancerSettingsHttpCookie { + /** + * Name of the cookie. + */ + name?: string; + /** + * Path to set for the cookie. + */ + path?: string; + /** + * Lifetime of the cookie. + */ + ttl?: Schema$Duration; + } + /** + * The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing + */ + export interface Schema$CorsPolicy { + /** + * In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header. Default is false. + */ + allowCredentials?: boolean; + /** + * Specifies the content for the Access-Control-Allow-Headers header. + */ + allowHeaders?: string[]; + /** + * Specifies the content for the Access-Control-Allow-Methods header. + */ + allowMethods?: string[]; + /** + * Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex. + */ + allowOriginRegexes?: string[]; + /** + * Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex. + */ + allowOrigins?: string[]; + /** + * If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. + */ + disabled?: boolean; + /** + * Specifies the content for the Access-Control-Expose-Headers header. + */ + exposeHeaders?: string[]; + /** + * Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. + */ + maxAge?: number; + } /** * Represents a customer-supplied encryption key */ @@ -1641,7 +1780,7 @@ export namespace compute_beta { state?: string; } /** - * A Disk resource. (== resource_for beta.disks ==) (== resource_for v1.disks ==) + * Represents a Persistent Disk resource. Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for beta.disks ==) (== resource_for v1.disks ==) (== resource_for v1.regionDisks ==) (== resource_for beta.regionDisks ==) */ export interface Schema$Disk { /** @@ -1653,7 +1792,7 @@ export namespace compute_beta { */ description?: string; /** - * Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. + * Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; /** @@ -1757,11 +1896,11 @@ export namespace compute_beta { */ storageType?: string; /** - * URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: project/zones/zone/diskTypes/pd-standard or pd-ssd + * URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd */ type?: string; /** - * [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance + * [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance */ users?: string[]; /** @@ -1896,7 +2035,7 @@ export namespace compute_beta { }; } /** - * A DiskType resource. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==) + * Represents a Disk Type resource. You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==) (== resource_for v1.regionDiskTypes ==) (== resource_for beta.regionDiskTypes ==) */ export interface Schema$DiskType { /** @@ -2042,13 +2181,26 @@ export namespace compute_beta { */ zone?: string; } + /** + * A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. + */ + export interface Schema$Duration { + /** + * Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + */ + nanos?: number; + /** + * Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + */ + seconds?: string; + } export interface Schema$ExchangedPeeringRoute { /** * The destination range of the route. */ destRange?: string; /** - * If the peering route is imported if there is no confliction. + * True if the peering route has been imported from a peer. The actual import happens if the field networkPeering.importCustomRoutes is true for this network, and networkPeering.exportCustomRoutes is true for the peer network, and the import does not result in a route conflict. */ imported?: boolean; /** @@ -2208,7 +2360,7 @@ export namespace compute_beta { }; } /** - * Represents a Firewall resource. + * Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules. */ export interface Schema$Firewall { /** @@ -2224,19 +2376,19 @@ export namespace compute_beta { */ denied?: Array<{IPProtocol?: string; ports?: string[]}>; /** - * An optional description of this resource. Provide this property when you create the resource. + * An optional description of this resource. Provide this field when you create the resource. */ description?: string; /** - * If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. + * If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. */ destinationRanges?: string[]; /** - * Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags. + * Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields. */ direction?: string; /** - * Denotes whether the firewall rule is disabled, i.e not applied to the network it is associated with. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. + * Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. */ disabled?: boolean; /** @@ -2256,15 +2408,15 @@ export namespace compute_beta { */ logConfig?: Schema$FirewallLogConfig; /** - * 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 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. */ name?: string; /** - * URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default + * URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default */ network?: string; /** - * Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority. + * Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`. */ priority?: number; /** @@ -2272,15 +2424,15 @@ export namespace compute_beta { */ selfLink?: string; /** - * If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported. + * If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported. */ sourceRanges?: string[]; /** - * If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. + * If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. */ sourceServiceAccounts?: string[]; /** - * If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. + * If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply. */ sourceTags?: string[]; /** @@ -2352,7 +2504,7 @@ export namespace compute_beta { percent?: number; } /** - * A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, ports] tuple. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) + * Represents a Forwarding Rule resource. A forwardingRules resource represents a regional forwarding rule. Regional external forwarding rules can reference any of the following resources: - A target instance - A Cloud VPN Classic gateway (targetVpnGateway), - A target pool for a Network Load Balancer - A global target HTTP(S) proxy for an HTTP(S) load balancer using Standard Tier - A target SSL proxy for a SSL Proxy load balancer using Standard Tier - A target TCP proxy for a TCP Proxy load balancer using Standard Tier. Regional internal forwarding rules can reference the backend service of an internal TCP/UDP load balancer. For regional internal forwarding rules, the following applies: - If the loadBalancingScheme for the load balancer is INTERNAL, then the forwarding rule references a regional internal backend service. - If the loadBalancingScheme for the load balancer is INTERNAL_MANAGED, then the forwarding rule must reference a regional target HTTP(S) proxy. For more information, read Using Forwarding rules. A globalForwardingRules resource represents a global forwarding rule. Global forwarding rules are only used by load balancers that use Premium Tier. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) */ export interface Schema$ForwardingRule { /** @@ -2411,6 +2563,10 @@ export namespace compute_beta { * This signifies what the ForwardingRule will be used for and can only take 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; + /** + * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overridden by those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. + */ + metadataFilters?: Schema$MetadataFilter[]; /** * 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. */ @@ -2622,7 +2778,7 @@ export namespace compute_beta { type?: string; } /** - * An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. + * Represents a Health Check resource. Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts. To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks. */ export interface Schema$HealthCheck { /** @@ -2656,6 +2812,10 @@ export namespace compute_beta { * 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; + /** + * [Output Only] Region where the health check resides. Not applicable to global health checks. + */ + region?: string; /** * [Output Only] Server-defined URL for the resource. */ @@ -2714,188 +2874,15 @@ export namespace compute_beta { export interface Schema$HealthCheckReference { healthCheck?: string; } - export interface Schema$HealthStatus { - /** - * Health state of the instance. - */ - healthState?: string; - /** - * URL of the instance resource. - */ - instance?: string; - /** - * The IP address represented by this resource. - */ - ipAddress?: string; - /** - * The port on the instance. - */ - port?: number; - } - export interface Schema$HealthStatusForNetworkEndpoint { - /** - * URL of the backend service associated with the health state of the network endpoint. - */ - backendService?: Schema$BackendServiceReference; - /** - * URL of the forwarding rule associated with the health state of the network endpoint. - */ - forwardingRule?: Schema$ForwardingRuleReference; - /** - * URL of the health check associated with the health state of the network endpoint. - */ - healthCheck?: Schema$HealthCheckReference; - /** - * Health state of the network endpoint determined based on the health checks configured. - */ - healthState?: string; - } - /** - * UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. - */ - export interface Schema$HostRule { - /** - * An optional description of this resource. Provide this property when you create the resource. - */ - description?: string; - /** - * The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. - */ - hosts?: string[]; - /** - * The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion. - */ - pathMatcher?: string; - } - export interface Schema$HTTP2HealthCheck { - /** - * The value of the host header in the HTTP/2 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, HTTP2 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 HTTP/2 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; - } - export interface Schema$HTTPHealthCheck { - /** - * The value of the host header in the HTTP 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 80. 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, HTTP 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 HTTP 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 HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP. - */ - export interface Schema$HttpHealthCheck { - /** - * How often (in seconds) to send a health check. The default value is 5 seconds. - */ - checkIntervalSec?: number; - /** - * [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; - /** - * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. - */ - healthyThreshold?: number; - /** - * The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. - */ - host?: string; - /** - * [Output Only] The unique identifier for the resource. This identifier is defined by the server. - */ - id?: string; - /** - * [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. - */ - 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; - /** - * The TCP port number for the HTTP health check request. The default value is 80. - */ - port?: number; - /** - * The request path of the HTTP health check request. The default value is /. - */ - requestPath?: string; - /** - * [Output Only] Server-defined URL for the resource. - */ - selfLink?: string; - /** - * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. - */ - timeoutSec?: number; - /** - * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. - */ - unhealthyThreshold?: number; - } - /** - * Contains a list of HttpHealthCheck resources. - */ - export interface Schema$HttpHealthCheckList { + export interface Schema$HealthChecksAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ id?: string; /** - * A list of HttpHealthCheck resources. + * A list of HealthChecksScopedList resources. */ - items?: Schema$HttpHealthCheck[]; + items?: {[key: string]: Schema$HealthChecksScopedList}; /** * Type of resource. */ @@ -2917,6 +2904,489 @@ export namespace compute_beta { message?: string; }; } + export interface Schema$HealthChecksScopedList { + /** + * A list of HealthChecks contained in this scope. + */ + healthChecks?: Schema$HealthCheck[]; + /** + * Informational warning which replaces the list of backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } + export interface Schema$HealthStatus { + /** + * Health state of the instance. + */ + healthState?: string; + /** + * URL of the instance resource. + */ + instance?: string; + /** + * The IP address represented by this resource. + */ + ipAddress?: string; + /** + * The port on the instance. + */ + port?: number; + } + export interface Schema$HealthStatusForNetworkEndpoint { + /** + * URL of the backend service associated with the health state of the network endpoint. + */ + backendService?: Schema$BackendServiceReference; + /** + * URL of the forwarding rule associated with the health state of the network endpoint. + */ + forwardingRule?: Schema$ForwardingRuleReference; + /** + * URL of the health check associated with the health state of the network endpoint. + */ + healthCheck?: Schema$HealthCheckReference; + /** + * Health state of the network endpoint determined based on the health checks configured. + */ + healthState?: string; + } + /** + * UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. + */ + export interface Schema$HostRule { + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string; + /** + * The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. + */ + hosts?: string[]; + /** + * The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion. + */ + pathMatcher?: string; + } + export interface Schema$HTTP2HealthCheck { + /** + * The value of the host header in the HTTP/2 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, HTTP2 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 HTTP/2 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; + } + /** + * Specification for how requests are aborted as part of fault injection. + */ + export interface Schema$HttpFaultAbort { + /** + * The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. + */ + httpStatus?: number; + /** + * The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive. + */ + percentage?: number; + } + /** + * Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. + */ + export interface Schema$HttpFaultDelay { + /** + * Specifies the value of the fixed delay interval. + */ + fixedDelay?: Schema$Duration; + /** + * The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive. + */ + percentage?: number; + } + /** + * The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. + */ + export interface Schema$HttpFaultInjection { + /** + * The specification for how client requests are aborted as part of fault injection. + */ + abort?: Schema$HttpFaultAbort; + /** + * The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. + */ + delay?: Schema$HttpFaultDelay; + } + /** + * The request and response header transformations that take effect before the request is passed along to the selected backendService. + */ + export interface Schema$HttpHeaderAction { + /** + * Headers to add to a matching request prior to forwarding the request to the backendService. + */ + requestHeadersToAdd?: Schema$HttpHeaderOption[]; + /** + * A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. + */ + requestHeadersToRemove?: string[]; + /** + * Headers to add the response prior to sending the response back to the client. + */ + responseHeadersToAdd?: Schema$HttpHeaderOption[]; + /** + * A list of header names for headers that need to be removed from the response prior to sending the response back to the client. + */ + responseHeadersToRemove?: string[]; + } + /** + * matchRule criteria for request header matches. + */ + export interface Schema$HttpHeaderMatch { + /** + * The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + exactMatch?: string; + /** + * The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". + */ + headerName?: string; + /** + * If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. The default setting is false. + */ + invertMatch?: boolean; + /** + * The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + prefixMatch?: string; + /** + * A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + presentMatch?: boolean; + /** + * The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + rangeMatch?: Schema$Int64RangeMatch; + /** + * The value of the header must match the regualar expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + regexMatch?: string; + /** + * The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + suffixMatch?: string; + } + /** + * Specification determining how headers are added to requests or responses. + */ + export interface Schema$HttpHeaderOption { + /** + * The name of the header. + */ + headerName?: string; + /** + * The value of the header to add. + */ + headerValue?: string; + /** + * If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false. + */ + replace?: boolean; + } + export interface Schema$HTTPHealthCheck { + /** + * The value of the host header in the HTTP 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 80. 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, HTTP 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 HTTP 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; + } + /** + * Represents a legacy HTTP Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. + */ + export interface Schema$HttpHealthCheck { + /** + * How often (in seconds) to send a health check. The default value is 5 seconds. + */ + checkIntervalSec?: number; + /** + * [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; + /** + * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. + */ + healthyThreshold?: number; + /** + * The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. + */ + host?: string; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string; + /** + * [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. + */ + 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; + /** + * The TCP port number for the HTTP health check request. The default value is 80. + */ + port?: number; + /** + * The request path of the HTTP health check request. The default value is /. This field does not support query parameters. + */ + requestPath?: string; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string; + /** + * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. + */ + timeoutSec?: number; + /** + * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. + */ + unhealthyThreshold?: number; + } + /** + * Contains a list of HttpHealthCheck resources. + */ + export interface Schema$HttpHealthCheckList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of HttpHealthCheck resources. + */ + items?: Schema$HttpHealthCheck[]; + /** + * 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?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } + /** + * HttpRouteRuleMatch criteria for a request's query parameter. + */ + export interface Schema$HttpQueryParameterMatch { + /** + * The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set. + */ + exactMatch?: string; + /** + * The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails. + */ + name?: string; + /** + * Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch and regexMatch must be set. + */ + presentMatch?: boolean; + /** + * The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set. + */ + regexMatch?: string; + } + /** + * Specifies settings for an HTTP redirect. + */ + export interface Schema$HttpRedirectAction { + /** + * The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters. + */ + hostRedirect?: string; + /** + * If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. + */ + httpsRedirect?: boolean; + /** + * The path that will be used in the redirect response instead of the one that was supplied in the request. Only one of pathRedirect or prefixRedirect must be specified. The value must be between 1 and 1024 characters. + */ + pathRedirect?: string; + /** + * The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. + */ + prefixRedirect?: string; + /** + * The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. + */ + redirectResponseCode?: string; + /** + * If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. + */ + stripQuery?: boolean; + } + /** + * The retry policy associates with HttpRouteRule + */ + export interface Schema$HttpRetryPolicy { + /** + * Specifies the allowed number retries. This number must be > 0. + */ + numRetries?: number; + /** + * Specifies a non-zero timeout per retry attempt. + */ + perTryTimeout?: Schema$Duration; + /** + * Specfies one or more conditions when this retry rule applies. Valid values are: - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable + */ + retryConditions?: string[]; + } + export interface Schema$HttpRouteAction { + /** + * The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing + */ + corsPolicy?: Schema$CorsPolicy; + /** + * The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. + */ + faultInjectionPolicy?: Schema$HttpFaultInjection; + /** + * Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. + */ + requestMirrorPolicy?: Schema$RequestMirrorPolicy; + /** + * Specifies the retry policy associated with this route. + */ + retryPolicy?: Schema$HttpRetryPolicy; + /** + * Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. + */ + timeout?: Schema$Duration; + /** + * The spec to modify the URL of the request, prior to forwarding the request to the matched service + */ + urlRewrite?: Schema$UrlRewrite; + /** + * A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. + */ + weightedBackendServices?: Schema$WeightedBackendService[]; + } + /** + * An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform. + */ + export interface Schema$HttpRouteRule { + /** + * Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction + */ + headerAction?: Schema$HttpHeaderAction; + matchRules?: Schema$HttpRouteRuleMatch[]; + /** + * In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. + */ + routeAction?: Schema$HttpRouteAction; + /** + * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. + */ + service?: string; + /** + * When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. + */ + urlRedirect?: Schema$HttpRedirectAction; + } + /** + * HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur. + */ + export interface Schema$HttpRouteRuleMatch { + /** + * For satifying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. FullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + */ + fullPathMatch?: string; + /** + * Specifies a list of header match criteria, all of which must match corresponding headers in the request. + */ + headerMatches?: Schema$HttpHeaderMatch[]; + /** + * Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. caseSensitive must not be used with regexMatch. + */ + ignoreCase?: boolean; + /** + * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. + */ + metadataFilters?: Schema$MetadataFilter[]; + /** + * For satifying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + */ + prefixMatch?: string; + /** + * Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. + */ + queryParameterMatches?: Schema$HttpQueryParameterMatch[]; + /** + * For satifying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + */ + regexMatch?: string; + } 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. @@ -2948,7 +3418,7 @@ export namespace compute_beta { response?: string; } /** - * An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS. + * Represents a legacy HTTPS Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. */ export interface Schema$HttpsHealthCheck { /** @@ -3038,7 +3508,7 @@ export namespace compute_beta { }; } /** - * An Image resource. (== resource_for beta.images ==) (== resource_for v1.images ==) + * Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for beta.images ==) (== resource_for v1.images ==) */ export interface Schema$Image { /** @@ -3153,6 +3623,10 @@ export namespace compute_beta { * [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; + /** + * GCS bucket storage location of the image (regional or multi-regional). + */ + storageLocations?: string[]; } /** * Contains a list of images. @@ -3188,7 +3662,7 @@ export namespace compute_beta { }; } /** - * An Instance resource. (== resource_for beta.instances ==) (== resource_for v1.instances ==) + * Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for beta.instances ==) (== resource_for v1.instances ==) */ export interface Schema$Instance { /** @@ -3261,7 +3735,7 @@ export namespace compute_beta { */ networkInterfaces?: Schema$NetworkInterface[]; /** - * The configuration of desired allocations which this Instance could consume capacity from. + * Specifies the reservations that this instance can consume from. */ reservationAffinity?: Schema$ReservationAffinity; /** @@ -3307,7 +3781,7 @@ export namespace compute_beta { */ id?: string; /** - * A list of InstancesScopedList resources. + * An object that contains a list of instances scoped by zone. */ items?: {[key: string]: Schema$InstancesScopedList}; /** @@ -3332,7 +3806,7 @@ export namespace compute_beta { }; } /** - * InstanceGroups (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) + * Represents an unmanaged Instance Group resource. Use unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. For more information, read Instance groups. For zonal unmanaged Instance Group, use instanceGroups resource. For regional unmanaged Instance Group, use regionInstanceGroups resource. (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) */ export interface Schema$InstanceGroup { /** @@ -3452,7 +3926,7 @@ export namespace compute_beta { }; } /** - * An Instance Group Manager resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) + * Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) */ export interface Schema$InstanceGroupManager { /** @@ -3692,15 +4166,15 @@ export namespace compute_beta { */ export interface Schema$InstanceGroupManagersApplyUpdatesRequest { /** - * The list of URLs of one or more instances for which we want to apply updates on this managed instance group. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + * The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; /** - * The minimal action that should be perfomed on the instances. By default NONE. + * The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update. */ minimalAction?: string; /** - * The most disruptive action that allowed to be performed on the instances. By default REPLACE. + * The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail. */ mostDisruptiveAllowedAction?: string; } @@ -3803,6 +4277,9 @@ export namespace compute_beta { * Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]. */ minReadySec?: number; + /** + * The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls). + */ type?: string; } export interface Schema$InstanceGroupManagerVersion { @@ -4009,7 +4486,7 @@ export namespace compute_beta { */ networkInterfaces?: Schema$NetworkInterface[]; /** - * The configuration of desired reservations which this Instance could consume capacity from. + * Specifies the reservations that this instance can consume from. */ reservationAffinity?: Schema$ReservationAffinity; /** @@ -4102,7 +4579,7 @@ export namespace compute_beta { disks?: Schema$CustomerEncryptionKeyProtectedDisk[]; } /** - * An Instance Template resource. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==) + * Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==) */ export interface Schema$InstanceTemplate { /** @@ -4190,7 +4667,20 @@ export namespace compute_beta { status?: string; } /** - * Represents an Interconnects resource. The Interconnects resource is a dedicated connection between Google's network and your on-premises network. For more information, see the Dedicated overview page. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) + * HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. + */ + export interface Schema$Int64RangeMatch { + /** + * The end of the range (exclusive) in signed long integer format. + */ + rangeEnd?: string; + /** + * The start of the range (inclusive) in signed long integer format. + */ + rangeStart?: string; + } + /** + * Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) */ export interface Schema$Interconnect { /** @@ -4234,7 +4724,7 @@ export namespace compute_beta { */ interconnectAttachments?: string[]; /** - * Type of interconnect. Note that "IT_PRIVATE" has been deprecated in favor of "DEDICATED" + * Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. */ interconnectType?: string; /** @@ -4250,7 +4740,7 @@ export namespace compute_beta { */ labels?: {[key: string]: string}; /** - * Type of link requested. This field indicates speed of each of the links in the bundle, not the entire bundle. + * Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. */ linkType?: string; /** @@ -4266,7 +4756,7 @@ export namespace compute_beta { */ nocContactEmail?: string; /** - * [Output Only] The current status of whether or not this Interconnect is functional. + * [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. */ operationalStatus?: string; /** @@ -4286,12 +4776,12 @@ export namespace compute_beta { */ selfLink?: string; /** - * [Output Only] The current state of whether or not this Interconnect is functional. + * [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. */ state?: string; } /** - * Represents an InterconnectAttachment (VLAN attachment) resource. For more information, see Creating VLAN Attachments. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==) + * Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==) */ export interface Schema$InterconnectAttachment { /** @@ -4299,7 +4789,7 @@ export namespace compute_beta { */ adminEnabled?: boolean; /** - * Provisioned bandwidth capacity for the interconnectAttachment. Can be set by the partner to update the customer's provisioned bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED. + * Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s */ bandwidth?: string; /** @@ -4323,11 +4813,11 @@ export namespace compute_beta { */ description?: string; /** - * Desired availability domain for the attachment. Only available for type PARTNER, at creation time. For improved reliability, customers should configure a pair of attachments with one per availability domain. The selected availability domain will be provided to the Partner via the pairing key so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. + * Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. */ edgeAvailabilityDomain?: string; /** - * [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. + * [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used. */ googleReferenceId?: string; /** @@ -4355,7 +4845,7 @@ export namespace compute_beta { */ name?: string; /** - * [Output Only] The current status of whether or not this interconnect attachment is functional. + * [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. */ operationalStatus?: string; /** @@ -4363,7 +4853,7 @@ export namespace compute_beta { */ pairingKey?: string; /** - * Optional BGP ASN for the router that should be supplied by a layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. + * Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. */ partnerAsn?: string; /** @@ -4387,9 +4877,12 @@ export namespace compute_beta { */ selfLink?: string; /** - * [Output Only] The current state of this attachment's functionality. + * [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. */ state?: string; + /** + * The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. + */ type?: string; /** * The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. @@ -4472,7 +4965,7 @@ export namespace compute_beta { */ partnerName?: string; /** - * URL of the Partner?s portal for this Attachment. Partners may customise this to be a deep-link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. + * URL of the Partner?s portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. */ portalUrl?: string; } @@ -4555,6 +5048,9 @@ export namespace compute_beta { * System ID of the port on the neighbor?s side of the LACP exchange. */ neighborSystemId?: string; + /** + * The state of a LACP link, which can take one of the following values: - ACTIVE: The link is configured and active within the bundle. - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty. + */ state?: string; } export interface Schema$InterconnectDiagnosticsLinkOpticalPower { @@ -4624,7 +5120,7 @@ export namespace compute_beta { }; } /** - * Represents an InterconnectLocations resource. The InterconnectLocations resource describes the locations where you can connect to Google's networks. For more information, see Colocation Facilities. + * Represents an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments. */ export interface Schema$InterconnectLocation { /** @@ -4640,7 +5136,7 @@ export namespace compute_beta { */ city?: string; /** - * [Output Only] Continent for this location. + * [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA */ continent?: string; /** @@ -4684,7 +5180,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * [Output Only] The status of this InterconnectLocation. If the status is AVAILABLE, new Interconnects may be provisioned in this InterconnectLocation. Otherwise, no new Interconnects may be provisioned. + * [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. */ status?: string; } @@ -4755,7 +5251,7 @@ export namespace compute_beta { */ endTime?: string; /** - * Form this outage is expected to take. Note that the "IT_" versions of this enum have been deprecated in favor of the unprefixed values. + * Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. */ issueType?: string; /** @@ -4763,7 +5259,7 @@ export namespace compute_beta { */ name?: string; /** - * The party that generated this notification. Note that "NSRC_GOOGLE" has been deprecated in favor of "GOOGLE" + * The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. */ source?: string; /** @@ -4771,7 +5267,7 @@ export namespace compute_beta { */ startTime?: string; /** - * State of this notification. Note that the "NS_" versions of this enum have been deprecated in favor of the unprefixed values. + * State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values. */ state?: string; } @@ -4955,12 +5451,12 @@ export namespace compute_beta { */ export interface Schema$LogConfigDataAccessOptions { /** - * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152). + * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. */ logMode?: string; } /** - * A Machine Type resource. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==) + * Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==) */ export interface Schema$MachineType { /** @@ -5157,6 +5653,32 @@ export namespace compute_beta { */ kind?: string; } + /** + * Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers. + */ + export interface Schema$MetadataFilter { + /** + * The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. + */ + filterLabels?: Schema$MetadataFilterLabelMatch[]; + /** + * Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: All filterLabels must have matching labels in the provided metadata. + */ + filterMatchCriteria?: string; + } + /** + * MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer. + */ + export interface Schema$MetadataFilterLabelMatch { + /** + * Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long. + */ + name?: string; + /** + * The value of the label must match the specified value. value can have a maximum length of 1024 characters. + */ + value?: string; + } /** * The named port. For example: . */ @@ -5171,7 +5693,7 @@ export namespace compute_beta { port?: number; } /** - * Represents a Network resource. Read Virtual Private Cloud (VPC) Network Overview for more information. (== resource_for v1.networks ==) (== resource_for beta.networks ==) + * Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==) */ export interface Schema$Network { /** @@ -5183,11 +5705,11 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you create the resource. + * An optional description of this resource. Provide this field when you create the resource. */ description?: string; /** - * [Output Only] The gateway address for default routing out of the network. This value is read only and is selected by GCP. + * [Output Only] The gateway address for default routing out of the network, selected by GCP. */ gatewayIPv4?: string; /** @@ -5203,7 +5725,7 @@ export namespace compute_beta { */ 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 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. */ name?: string; /** @@ -5455,7 +5977,7 @@ export namespace compute_beta { */ accessConfigs?: Schema$AccessConfig[]; /** - * An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. + * An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. */ aliasIpRanges?: Schema$AliasIpRange[]; /** @@ -5467,19 +5989,19 @@ export namespace compute_beta { */ kind?: string; /** - * [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. + * [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. */ name?: string; /** - * URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network global/networks/default is used. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/network - projects/project/global/networks/network - global/networks/default + * URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/network - projects/project/global/networks/network - global/networks/default */ network?: string; /** - * An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. + * An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. */ networkIP?: string; /** - * The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - regions/region/subnetworks/subnetwork + * The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - regions/region/subnetworks/subnetwork */ subnetwork?: string; } @@ -5521,11 +6043,11 @@ export namespace compute_beta { */ export interface Schema$NetworkPeering { /** - * This field will be deprecated soon. Prefer using exchange_subnet_routes instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. + * This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ autoCreateRoutes?: boolean; /** - * Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. + * Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ exchangeSubnetRoutes?: boolean; /** @@ -5537,7 +6059,7 @@ export namespace compute_beta { */ importCustomRoutes?: boolean; /** - * Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + * Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -5545,7 +6067,7 @@ export namespace compute_beta { */ network?: string; /** - * [Output Only] State for the peering. + * [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. */ state?: string; /** @@ -5558,13 +6080,13 @@ export namespace compute_beta { */ export interface Schema$NetworkRoutingConfig { /** - * The network-wide routing mode to use. If set to REGIONAL, this network's cloud routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's cloud routers will advertise routes with all subnets of this network, across regions. + * The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. */ routingMode?: string; } export interface Schema$NetworksAddPeeringRequest { /** - * This field will be deprecated soon. Prefer using exchange_subnet_routes in network_peering instead. Whether Google Compute Engine manages the routes automatically. + * This field will be deprecated soon. Use exchange_subnet_routes in network_peering instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ autoCreateRoutes?: boolean; /** @@ -5572,7 +6094,7 @@ export namespace compute_beta { */ name?: string; /** - * Network peering parameters. In order to specify route policies for peering using import/export custom routes, you will have to fill all peering related parameters (name, peer network, exchange_subnet_routes) in network_peeringfield. Corresponding fields in NetworksAddPeeringRequest will be deprecated soon. + * Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon. */ networkPeering?: Schema$NetworkPeering; /** @@ -5590,7 +6112,7 @@ export namespace compute_beta { networkPeering?: Schema$NetworkPeering; } /** - * A NodeGroup resource. To create a node group, you must first create a node templates. To learn more about node groups and sole-tenant nodes, read the Sole-tenant nodes documentation. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) + * Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) NextID: 15 */ export interface Schema$NodeGroup { /** @@ -5773,7 +6295,7 @@ export namespace compute_beta { nodeTemplate?: string; } /** - * A Node Template resource. To learn more about node templates and sole-tenant nodes, read the Sole-tenant nodes documentation. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) + * Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) (== NextID: 16 ==) */ export interface Schema$NodeTemplate { /** @@ -5817,7 +6339,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * Binding properties for the physical server. + * Sets the binding properties for the physical server. Valid values include: - [Default] RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information. */ serverBinding?: Schema$ServerBinding; /** @@ -5912,7 +6434,7 @@ export namespace compute_beta { }; } /** - * A Node Type resource. + * Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for beta.nodeTypes ==) (== resource_for v1.nodeTypes ==) */ export interface Schema$NodeType { /** @@ -6042,7 +6564,7 @@ export namespace compute_beta { }; } /** - * An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) + * Represents an Operation resource. You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) */ export interface Schema$Operation { /** @@ -6100,7 +6622,7 @@ export namespace compute_beta { */ progress?: number; /** - * [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + * [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. */ region?: string; /** @@ -6140,7 +6662,7 @@ export namespace compute_beta { message?: string; }>; /** - * [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + * [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. */ zone?: string; } @@ -6221,18 +6743,79 @@ export namespace compute_beta { message?: string; }; } + /** + * Settings controlling eviction of unhealthy hosts from the load balancing pool. + */ + export interface Schema$OutlierDetection { + /** + * The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + */ + baseEjectionTime?: Schema$Duration; + /** + * Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + */ + consecutiveErrors?: number; + /** + * The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5. + */ + consecutiveGatewayFailure?: number; + /** + * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + */ + enforcingConsecutiveErrors?: number; + /** + * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + */ + enforcingConsecutiveGatewayFailure?: number; + /** + * The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + */ + enforcingSuccessRate?: number; + /** + * Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds. + */ + interval?: Schema$Duration; + /** + * Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%. + */ + maxEjectionPercent?: number; + /** + * The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. + */ + successRateMinimumHosts?: number; + /** + * The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. + */ + successRateRequestVolume?: number; + /** + * This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + */ + successRateStdevFactor?: number; + } /** * A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. */ export interface Schema$PathMatcher { + /** + * defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. + */ + defaultRouteAction?: Schema$HttpRouteAction; /** * The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use */ defaultService?: string; + /** + * When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. + */ + defaultUrlRedirect?: Schema$HttpRedirectAction; /** * An optional description of this resource. Provide this property when you create the resource. */ description?: string; + /** + * Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap + */ + headerAction?: Schema$HttpHeaderAction; /** * The name to which this PathMatcher is referred by the HostRule. */ @@ -6241,6 +6824,10 @@ export namespace compute_beta { * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Only one of pathRules or routeRules must be set. */ pathRules?: Schema$PathRule[]; + /** + * The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Only one of pathRules or routeRules must be set. + */ + routeRules?: Schema$HttpRouteRule[]; } /** * A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. @@ -6250,10 +6837,18 @@ export namespace compute_beta { * The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. */ paths?: string[]; + /** + * In response to a matching path, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. + */ + routeAction?: Schema$HttpRouteAction; /** * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. */ service?: string; + /** + * When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. + */ + urlRedirect?: Schema$HttpRedirectAction; } /** * 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). @@ -6288,7 +6883,7 @@ export namespace compute_beta { expressionSets?: Schema$WafExpressionSet[]; } /** - * A Project resource. For an overview of projects, see Cloud Platform Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) + * Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) */ export interface Schema$Project { /** @@ -6425,7 +7020,7 @@ export namespace compute_beta { target?: string; } /** - * Region resource. (== resource_for beta.regions ==) (== resource_for v1.regions ==) + * Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for beta.regions ==) (== resource_for v1.regions ==) */ export interface Schema$Region { /** @@ -6633,15 +7228,15 @@ export namespace compute_beta { */ export interface Schema$RegionInstanceGroupManagersApplyUpdatesRequest { /** - * The list of instances for which we want to apply changes on this managed instance group. + * The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[]; /** - * The minimal action that should be perfomed on the instances. By default NONE. + * The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update. */ minimalAction?: string; /** - * The most disruptive action that allowed to be performed on the instances. By default REPLACE. + * The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail. */ mostDisruptiveAllowedAction?: string; } @@ -6793,8 +7388,29 @@ export namespace compute_beta { */ 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. + */ + resource?: Schema$UrlMap; + } + /** + * A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. + */ + export interface Schema$RequestMirrorPolicy { + /** + * The full or partial URL to the BackendService resource being mirrored to. + */ + backendService?: string; + } /** - * Reservation resource + * Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for beta.reservations ==) (== resource_for v1.reservations ==) (== NextID: 13 ==) */ export interface Schema$Reservation { /** @@ -6830,25 +7446,32 @@ export namespace compute_beta { */ specificReservation?: Schema$AllocationSpecificSKUReservation; /** - * Indicates whether the reservation can be consumed by VMs with "any reservation" defined. If the field is set, then only VMs that target the reservation by name using --reservation-affinity can consume this reservation. + * Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. */ specificReservationRequired?: boolean; + /** + * [Output Only] The status of the reservation. + */ + status?: string; /** * Zone in which the reservation resides, must be provided if reservation is created with commitment creation. */ zone?: string; } /** - * AllocationAffinity is the configuration of desired allocation which this instance could take capacity from. + * Specifies the reservations that this instance can consume from. */ export interface Schema$ReservationAffinity { + /** + * Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples. + */ consumeReservationType?: string; /** - * Corresponds to the label key of reservation resource. + * Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value. */ key?: string; /** - * Corresponds to the label values of reservation resource. + * Corresponds to the label values of a reservation resource. */ values?: string[]; } @@ -7182,7 +7805,7 @@ export namespace compute_beta { 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 ==) + * Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for beta.routes ==) (== resource_for v1.routes ==) */ export interface Schema$Route { /** @@ -7190,7 +7813,7 @@ export namespace compute_beta { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you create the resource. + * An optional description of this resource. Provide this field when you create the resource. */ description?: string; /** @@ -7206,7 +7829,7 @@ export namespace compute_beta { */ 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 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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. */ name?: string; /** @@ -7214,7 +7837,7 @@ export namespace compute_beta { */ 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 + * 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/global/gateways/default-internet-gateway */ nextHopGateway?: string; /** @@ -7246,7 +7869,7 @@ export namespace compute_beta { */ 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. + * 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 cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive. */ priority?: number; /** @@ -7300,7 +7923,7 @@ export namespace compute_beta { }; } /** - * Router resource. + * Represents a Cloud Router resource. For more information about Cloud Router, read the the Cloud Router overview. */ export interface Schema$Router { /** @@ -7308,7 +7931,7 @@ export namespace compute_beta { */ bgp?: Schema$RouterBgp; /** - * BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273. + * BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273. */ bgpPeers?: Schema$RouterBgpPeer[]; /** @@ -7324,7 +7947,7 @@ export namespace compute_beta { */ id?: string; /** - * Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both. + * Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. */ interfaces?: Schema$RouterInterface[]; /** @@ -7336,7 +7959,7 @@ export namespace compute_beta { */ name?: string; /** - * A list of Nat services created in this router. + * A list of NAT services created in this router. */ nats?: Schema$RouterNat[]; /** @@ -7408,7 +8031,7 @@ export namespace compute_beta { */ advertisedIpRanges?: Schema$RouterAdvertisedIpRange[]; /** - * User-specified flag to indicate which mode to use for advertisement. + * User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM. */ advertiseMode?: string; /** @@ -7418,15 +8041,15 @@ export namespace compute_beta { } export interface Schema$RouterBgpPeer { /** - * User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in Bgp message). These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. + * User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. */ advertisedGroups?: string[]; /** - * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in Bgp message). These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. + * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. */ advertisedIpRanges?: Schema$RouterAdvertisedIpRange[]; /** - * The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win. + * The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win. */ advertisedRoutePriority?: number; /** @@ -7442,7 +8065,7 @@ export namespace compute_beta { */ ipAddress?: string; /** - * [Output Only] The resource that configures and manages this BGP peer. MANAGED_BY_USER is the default value and can be managed by you or other users; MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google will automatically create, update, and delete this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. + * [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. */ managementType?: string; /** @@ -7450,29 +8073,29 @@ export namespace compute_beta { */ name?: string; /** - * Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel. + * Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. */ peerAsn?: number; /** - * IP address of the BGP interface outside Google cloud. Only IPv4 is supported. + * IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. */ peerIpAddress?: string; } export interface Schema$RouterInterface { /** - * IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface. + * IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface. */ ipRange?: string; /** - * URI of the linked interconnect attachment. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment. + * URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be either be a VPN tunnel or an Interconnect attachment. */ linkedInterconnectAttachment?: string; /** - * URI of the linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment. + * URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be either a VPN tunnel or an Interconnect attachment. */ linkedVpnTunnel?: string; /** - * [Output Only] The resource that configures and manages this interface. MANAGED_BY_USER is the default value and can be managed by you or other users; MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google will automatically create, update, and delete this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. + * [Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. */ managementType?: string; /** @@ -7526,7 +8149,7 @@ export namespace compute_beta { */ logConfig?: Schema$RouterNatLogConfig; /** - * Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This gets rounded up to the nearest power of 2. Eg. if the value of this field is 50, at least 64 ports will be allocated to a VM. + * Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM. */ minPortsPerVm?: number; /** @@ -7534,15 +8157,15 @@ export namespace compute_beta { */ name?: string; /** - * Specify the NatIpAllocateOption. If it is AUTO_ONLY, then nat_ip should be empty. + * Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. */ natIpAllocateOption?: string; /** - * A list of URLs of the IP resources used for this Nat service. These IPs must be valid static external IP addresses assigned to the project. max_length is subject to change post alpha. + * A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project. */ natIps?: string[]; /** - * Specify the Nat option. If this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region. + * Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region. */ sourceSubnetworkIpRangesToNat?: string; /** @@ -7580,7 +8203,7 @@ export namespace compute_beta { */ export interface Schema$RouterNatSubnetworkToNat { /** - * URL for the subnetwork resource to use NAT. + * URL for the subnetwork resource that will use NAT. */ name?: string; /** @@ -7588,7 +8211,7 @@ export namespace compute_beta { */ secondaryIpRangeNames?: string[]; /** - * Specify the options for NAT ranges in the Subnetwork. All usages of single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] + * Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] */ sourceIpRangesToNat?: string[]; } @@ -7740,7 +8363,7 @@ export namespace compute_beta { permissions?: string[]; } /** - * Sets the scheduling options for an Instance. + * Sets the scheduling options for an Instance. NextID: 9 */ export interface Schema$Scheduling { /** @@ -7748,7 +8371,7 @@ export namespace compute_beta { */ automaticRestart?: boolean; /** - * A set of node affinity and anti-affinity. + * A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. */ nodeAffinities?: Schema$SchedulingNodeAffinity[]; /** @@ -7769,7 +8392,7 @@ export namespace compute_beta { */ key?: string; /** - * Defines the operation of node selection. + * Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. */ operator?: string; /** @@ -7784,7 +8407,7 @@ export namespace compute_beta { wafRules?: Schema$PreconfiguredWafSet; } /** - * A security policy is comprised of one or more rules. It can also be associated with one or more 'targets'. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) + * Represents a Cloud Armor Security Policy resource. Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) */ export interface Schema$SecurityPolicy { /** @@ -8076,7 +8699,7 @@ export namespace compute_beta { keyValue?: string; } /** - * A persistent disk snapshot resource. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) + * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) */ export interface Schema$Snapshot { /** @@ -8128,7 +8751,7 @@ export namespace compute_beta { */ selfLink?: string; /** - * Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. + * Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. */ snapshotEncryptionKey?: Schema$CustomerEncryptionKey; /** @@ -8203,7 +8826,7 @@ export namespace compute_beta { diskConfigs?: Schema$DiskInstantiationConfig[]; } /** - * An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) + * Represents an SSL Certificate resource. This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) */ export interface Schema$SslCertificate { /** @@ -8242,6 +8865,10 @@ export namespace compute_beta { * A write-only private key in PEM format. Only insert requests will include 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. */ @@ -8259,6 +8886,36 @@ export namespace compute_beta { */ 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?: {[key: string]: Schema$SslCertificatesScopedList}; + /** + * [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?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } /** * Contains a list of SslCertificate resources. */ @@ -8322,6 +8979,20 @@ export namespace compute_beta { */ 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?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } export interface Schema$SSLHealthCheck { /** * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. @@ -8382,7 +9053,7 @@ export namespace compute_beta { features?: string[]; } /** - * A SSL policy specifies the server-side support for SSL features. This can be attached to a TargetHttpsProxy or a TargetSslProxy. This affects connections between clients and the HTTPS or SSL proxy load balancer. They do not affect the connection between the load balancers and the backends. + * Represents a Cloud Armor Security Policy resource. Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for beta.sslPolicies ==) (== resource_for v1.sslPolicies ==) */ export interface Schema$SslPolicy { /** @@ -8445,7 +9116,7 @@ export namespace compute_beta { sslPolicy?: string; } /** - * A Subnetwork resource. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==) + * Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==) */ export interface Schema$Subnetwork { /** @@ -8485,7 +9156,7 @@ export namespace compute_beta { */ kind?: string; /** - * This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. + * This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Stackdriver. */ logConfig?: Schema$SubnetworkLogConfig; /** @@ -8500,10 +9171,18 @@ export namespace compute_beta { * Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. */ privateIpGoogleAccess?: boolean; + /** + * The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. + */ + purpose?: string; /** * URL of the region where the Subnetwork resides. This field can be set only at resource creation time. */ region?: string; + /** + * The role of subnetwork. Currenly, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. + */ + role?: string; /** * An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request. */ @@ -8512,6 +9191,10 @@ export namespace compute_beta { * [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 { /** @@ -8589,11 +9272,11 @@ export namespace compute_beta { */ enable?: boolean; /** - * 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. + * 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; /** - * 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. + * Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is INCLUDE_ALL_METADATA. */ metadata?: string; } @@ -8646,8 +9329,22 @@ export namespace compute_beta { */ items?: string[]; } + export interface Schema$TargetHttpProxiesScopedList { + /** + * A list of TargetHttpProxies contained in this scope. + */ + targetHttpProxies?: Schema$TargetHttpProxy[]; + /** + * Informational warning which replaces the list of backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } /** - * A TargetHttpProxy resource. This resource defines an HTTP proxy. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) + * Represents a Target HTTP Proxy resource. A target HTTP proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) */ export interface Schema$TargetHttpProxy { /** @@ -8670,6 +9367,10 @@ export namespace compute_beta { * 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; + /** + * [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. + */ + region?: string; /** * [Output Only] Server-defined URL for the resource. */ @@ -8679,6 +9380,36 @@ export namespace compute_beta { */ urlMap?: string; } + export interface Schema$TargetHttpProxyAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of TargetHttpProxiesScopedList resources. + */ + items?: {[key: string]: Schema$TargetHttpProxiesScopedList}; + /** + * [Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList 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?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } /** * A list of TargetHttpProxy resources. */ @@ -8712,6 +9443,20 @@ export namespace compute_beta { message?: string; }; } + 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?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } export interface Schema$TargetHttpsProxiesSetQuicOverrideRequest { /** * QUIC policy for the TargetHttpsProxy resource. @@ -8725,7 +9470,7 @@ export namespace compute_beta { sslCertificates?: string[]; } /** - * A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) + * Represents a Target HTTPS Proxy resource. A target HTTPS proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) */ export interface Schema$TargetHttpsProxy { /** @@ -8752,6 +9497,10 @@ export namespace compute_beta { * Specifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not 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. */ @@ -8769,6 +9518,36 @@ export namespace compute_beta { */ 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?: {[key: string]: Schema$TargetHttpsProxiesScopedList}; + /** + * [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?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } /** * Contains a list of TargetHttpsProxy resources. */ @@ -8803,7 +9582,7 @@ export namespace compute_beta { }; } /** - * A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) + * Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) */ export interface Schema$TargetInstance { /** @@ -8921,7 +9700,7 @@ export namespace compute_beta { }; } /** - * A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) + * Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) */ export interface Schema$TargetPool { /** @@ -9103,7 +9882,7 @@ export namespace compute_beta { sslCertificates?: string[]; } /** - * A TargetSslProxy resource. This resource defines an SSL proxy. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) + * Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) */ export interface Schema$TargetSslProxy { /** @@ -9193,7 +9972,7 @@ export namespace compute_beta { proxyHeader?: string; } /** - * A TargetTcpProxy resource. This resource defines a TCP proxy. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) + * Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference ta target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing Concepts. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) */ export interface Schema$TargetTcpProxy { /** @@ -9263,7 +10042,7 @@ export namespace compute_beta { }; } /** - * Represents a Target VPN gateway resource. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) + * Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) */ export interface Schema$TargetVpnGateway { /** @@ -9441,17 +10220,25 @@ export namespace compute_beta { permissions?: string[]; } /** - * A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. + * Represents a URL Map resource. A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts. */ export interface Schema$UrlMap { /** * [Output Only] Creation timestamp in RFC3339 text format. */ creationTimestamp?: string; + /** + * defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. + */ + defaultRouteAction?: Schema$HttpRouteAction; /** * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. */ defaultService?: string; + /** + * When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. + */ + defaultUrlRedirect?: Schema$HttpRedirectAction; /** * An optional description of this resource. Provide this property when you create the resource. */ @@ -9460,6 +10247,10 @@ 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, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. */ fingerprint?: string; + /** + * Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. + */ + headerAction?: Schema$HttpHeaderAction; /** * The list of HostRules to use against the URL. */ @@ -9480,6 +10271,10 @@ export namespace compute_beta { * The list of named PathMatchers to use against the URL. */ pathMatchers?: Schema$PathMatcher[]; + /** + * [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string; /** * [Output Only] Server-defined URL for the resource. */ @@ -9525,6 +10320,50 @@ export namespace compute_beta { 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?: {[key: string]: Schema$UrlMapsScopedList}; + /** + * 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?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } + 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?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } export interface Schema$UrlMapsValidateRequest { /** * Content of the UrlMap to be validated. @@ -9570,6 +10409,19 @@ export namespace compute_beta { */ testPassed?: boolean; } + /** + * The spec for modifying the path before sending the request to the matched backend service. + */ + export interface Schema$UrlRewrite { + /** + * Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters. + */ + hostRewrite?: string; + /** + * Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters. + */ + pathPrefixRewrite?: string; + } /** * Subnetwork which the current user has compute.subnetworks.use permission on. */ @@ -9911,7 +10763,7 @@ export namespace compute_beta { ipAddress?: string; } /** - * VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) + * Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) */ export interface Schema$VpnTunnel { /** @@ -10108,6 +10960,23 @@ export namespace compute_beta { */ id?: string; } + /** + * In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService + */ + export interface Schema$WeightedBackendService { + /** + * The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight. + */ + backendService?: string; + /** + * Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. + */ + headerAction?: Schema$HttpHeaderAction; + /** + * Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. The value must be between 0 and 1000 + */ + weight?: number; + } export interface Schema$XpnHostList { /** * [Output Only] Unique identifier for the resource; defined by the server. @@ -10152,7 +11021,7 @@ export namespace compute_beta { type?: string; } /** - * A Zone resource. (== resource_for beta.zones ==) (== resource_for v1.zones ==) Next ID: 17 + * Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones. (== resource_for beta.zones ==) (== resource_for v1.zones ==) */ export interface Schema$Zone { /** @@ -10381,7 +11250,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -10518,7 +11387,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -10663,7 +11532,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -10896,7 +11765,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -11027,7 +11896,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -11156,7 +12025,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -11182,7 +12051,7 @@ export namespace compute_beta { /** * compute.addresses.insert - * @desc Creates an address resource in the specified project using the data included in the request. + * @desc Creates an address resource in the specified project by using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -11289,7 +12158,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -11433,7 +12302,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -11571,7 +12440,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -11712,7 +12581,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -12044,7 +12913,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -12177,7 +13046,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -12308,7 +13177,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -12442,7 +13311,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -12586,7 +13455,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -12722,7 +13591,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -12863,7 +13732,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -12999,7 +13868,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -13294,7 +14163,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -13423,7 +14292,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -13500,7 +14369,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -13628,7 +14497,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -13758,7 +14627,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -13898,7 +14767,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -14032,7 +14901,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -14167,7 +15036,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -14436,7 +15305,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -14581,7 +15450,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -14715,7 +15584,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -14792,7 +15661,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -14920,7 +15789,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15056,7 +15925,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15189,7 +16058,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15330,7 +16199,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15465,7 +16334,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15600,7 +16469,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15737,7 +16606,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -15872,7 +16741,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16237,7 +17106,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16380,7 +17249,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16471,7 +17340,7 @@ export namespace compute_beta { * * @param {object} params Parameters for request * @param {string} params.disk Name of the persistent disk to snapshot. - * @param {boolean=} params.guestFlush + * @param {boolean=} params.guestFlush [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). * @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. @@ -16518,7 +17387,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16650,7 +17519,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16779,7 +17648,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16853,7 +17722,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -16987,7 +17856,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -17128,7 +17997,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -17207,7 +18076,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -17344,7 +18213,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -17419,7 +18288,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -17556,7 +18425,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -17697,7 +18566,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -17791,7 +18660,7 @@ export namespace compute_beta { */ disk?: string; /** - * + * [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). */ guestFlush?: boolean; /** @@ -18196,7 +19065,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -18324,7 +19193,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -18468,7 +19337,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -18630,7 +19499,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -18705,7 +19574,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -18781,7 +19650,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -18861,7 +19730,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -18937,7 +19806,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19017,7 +19886,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19280,7 +20149,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19405,7 +20274,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19534,7 +20403,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19673,7 +20542,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19806,7 +20675,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -19943,7 +20812,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -20077,7 +20946,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -20380,7 +21249,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -20518,7 +21387,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -20650,7 +21519,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -20784,7 +21653,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -20929,7 +21798,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -21007,7 +21876,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -21145,7 +22014,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -21283,7 +22152,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -21424,7 +22293,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -21802,7 +22671,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -21928,7 +22797,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -21954,7 +22823,7 @@ export namespace compute_beta { /** * compute.globalAddresses.insert - * @desc Creates an address resource in the specified project using the data included in the request. + * @desc Creates an address resource in the specified project by using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -22058,7 +22927,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22198,7 +23067,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22330,7 +23199,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22467,7 +23336,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22731,7 +23600,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22859,7 +23728,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -22989,7 +23858,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -23130,7 +23999,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -23207,7 +24076,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -23340,7 +24209,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -23474,7 +24343,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -23611,7 +24480,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -23941,7 +24810,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -24063,7 +24932,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -24191,7 +25060,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -24332,7 +25201,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -24452,229 +25321,55 @@ export namespace compute_beta { } /** - * compute.healthChecks.delete - * @desc Deletes the specified HealthCheck resource. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // Name of the HealthCheck resource to delete. - * healthCheck: 'my-health-check', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * compute.healthChecks.delete(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.healthChecks.delete + * compute.healthChecks.aggregatedList + * @desc Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. + * @alias compute.healthChecks.aggregatedList * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.healthCheck Name of the HealthCheck 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.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 */ - delete( - params?: Params$Resource$Healthchecks$Delete, + aggregatedList( + params?: Params$Resource$Healthchecks$Aggregatedlist, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Healthchecks$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Healthchecks$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Healthchecks$Delete - | BodyResponseCallback, - optionsOrCallback?: + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Healthchecks$Aggregatedlist, + options: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Healthchecks$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Healthchecks$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}/global/healthChecks/{healthCheck}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['project', 'healthCheck'], - pathParams: ['healthCheck', 'project'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * compute.healthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // Name of the HealthCheck resource to return. - * healthCheck: 'my-health-check', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * compute.healthChecks.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.healthChecks.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.healthCheck Name of the HealthCheck resource to return. - * @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 - */ - get( - params?: Params$Resource$Healthchecks$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Healthchecks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Healthchecks$Get, - callback: BodyResponseCallback + aggregatedList( + params: Params$Resource$Healthchecks$Aggregatedlist, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( paramsOrCallback?: - | Params$Resource$Healthchecks$Get - | BodyResponseCallback, + | Params$Resource$Healthchecks$Aggregatedlist + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Healthchecks$Get; + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Healthchecks$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Healthchecks$Get; + params = {} as Params$Resource$Healthchecks$Aggregatedlist; options = {}; } @@ -24683,33 +25378,36 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/global/healthChecks/{healthCheck}' + '/compute/beta/projects/{project}/aggregated/healthChecks' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['project', 'healthCheck'], - pathParams: ['healthCheck', 'project'], + requiredParams: ['project'], + pathParams: ['project'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.healthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the data included in the request. + * compute.healthChecks.delete + * @desc Deletes the specified HealthCheck resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -24733,14 +25431,13 @@ export namespace compute_beta { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * resource: { - * // TODO: Add desired properties to the request body. - * }, + * // Name of the HealthCheck resource to delete. + * healthCheck: 'my-health-check', // TODO: Update placeholder value. * * auth: authClient, * }; * - * compute.healthChecks.insert(request, function(err, response) { + * compute.healthChecks.delete(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -24764,34 +25461,34 @@ export namespace compute_beta { * callback(authClient); * }); * } - * @alias compute.healthChecks.insert + * @alias compute.healthChecks.delete * @memberOf! () * * @param {object} params Parameters for request + * @param {string} params.healthCheck Name of the HealthCheck 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 {().HealthCheck} 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$Healthchecks$Insert, + delete( + params?: Params$Resource$Healthchecks$Delete, options?: MethodOptions ): GaxiosPromise; - insert( - params: Params$Resource$Healthchecks$Insert, + delete( + params: Params$Resource$Healthchecks$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Healthchecks$Insert, + delete( + params: Params$Resource$Healthchecks$Delete, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Healthchecks$Insert + | Params$Resource$Healthchecks$Delete | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -24799,12 +25496,12 @@ export namespace compute_beta { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Healthchecks$Insert; + {}) as Params$Resource$Healthchecks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Healthchecks$Insert; + params = {} as Params$Resource$Healthchecks$Delete; options = {}; } @@ -24813,20 +25510,21 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( - rootUrl + '/compute/beta/projects/{project}/global/healthChecks' + rootUrl + + '/compute/beta/projects/{project}/global/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'healthCheck'], + pathParams: ['healthCheck', 'project'], context: this.context, }; if (callback) { @@ -24837,8 +25535,264 @@ export namespace compute_beta { } /** - * compute.healthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the specified project. + * compute.healthChecks.get + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // Name of the HealthCheck resource to return. + * healthCheck: 'my-health-check', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * compute.healthChecks.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.healthChecks.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheck Name of the HealthCheck resource to return. + * @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 + */ + get( + params?: Params$Resource$Healthchecks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Healthchecks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Healthchecks$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Healthchecks$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Healthchecks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Healthchecks$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/healthChecks/{healthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'healthCheck'], + pathParams: ['healthCheck', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.healthChecks.insert + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * compute.healthChecks.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.healthChecks.insert + * @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 {().HealthCheck} 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$Healthchecks$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Healthchecks$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Healthchecks$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Healthchecks$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Healthchecks$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Healthchecks$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/beta/projects/{project}/global/healthChecks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.healthChecks.list + * @desc Retrieves the list of HealthCheck resources available to the specified project. * @example * * // BEFORE RUNNING: * // --------------- @@ -24953,7 +25907,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -25087,7 +26041,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -25224,7 +26178,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -25359,7 +26313,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -25384,6 +26338,34 @@ export namespace compute_beta { } } + export interface Params$Resource$Healthchecks$Aggregatedlist + extends StandardParameters { + /** + * 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$Healthchecks$Delete extends StandardParameters { /** @@ -25651,7 +26633,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -25779,7 +26761,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -25909,7 +26891,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26050,7 +27032,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26185,7 +27167,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26322,7 +27304,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26457,7 +27439,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26750,7 +27732,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -26878,7 +27860,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27008,7 +27990,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27151,7 +28133,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27286,7 +28268,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27423,7 +28405,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27558,7 +28540,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27850,7 +28832,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -27982,7 +28964,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28107,7 +29089,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28232,7 +29214,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28305,7 +29287,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28435,7 +29417,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28574,7 +29556,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28647,7 +29629,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28779,7 +29761,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -28916,7 +29898,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -29265,7 +30247,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -29410,7 +30392,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -29494,7 +30476,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -29627,7 +30609,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -29765,7 +30747,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -29899,7 +30881,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -30033,7 +31015,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -30180,7 +31162,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -30349,7 +31331,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -30492,7 +31474,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -30630,7 +31612,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -30769,7 +31751,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -30907,7 +31889,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -31047,7 +32029,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -31185,7 +32167,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -31323,7 +32305,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -31464,7 +32446,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -31603,7 +32585,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32253,7 +33235,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32398,7 +33380,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32534,7 +33516,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32666,7 +33648,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32800,7 +33782,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -32945,7 +33927,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33103,7 +34085,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33244,7 +34226,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33382,7 +34364,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33523,7 +34505,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -33955,7 +34937,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -34100,7 +35082,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -34238,7 +35220,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -34370,7 +35352,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -34511,7 +35493,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -34654,7 +35636,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -34783,7 +35765,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -34863,7 +35845,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -34937,7 +35919,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -35073,7 +36055,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -35153,7 +36135,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -35231,7 +36213,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -35365,7 +36347,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -35509,7 +36491,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -35663,7 +36645,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -35795,7 +36777,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -35872,7 +36854,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36008,7 +36990,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36149,7 +37131,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36230,7 +37212,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36368,7 +37350,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36506,7 +37488,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36644,7 +37626,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36782,7 +37764,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -36920,7 +37902,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37058,7 +38040,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37196,7 +38178,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37276,7 +38258,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37356,7 +38338,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37494,7 +38476,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37572,7 +38554,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37704,7 +38686,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37844,7 +38826,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -37976,7 +38958,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38054,7 +39036,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38195,7 +39177,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38337,7 +39319,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38415,7 +39397,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38560,7 +39542,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38640,7 +39622,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -38720,7 +39702,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -39991,7 +40973,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40119,7 +41101,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40192,7 +41174,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40322,7 +41304,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40465,7 +41447,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40539,7 +41521,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40676,7 +41658,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -40980,7 +41962,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -41118,7 +42100,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -41252,7 +42234,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -41386,7 +42368,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -41535,7 +42517,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -41616,7 +42598,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -41694,7 +42676,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -41835,7 +42817,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42185,7 +43167,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42328,7 +43310,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42509,7 +43491,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42637,7 +43619,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42718,7 +43700,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42853,7 +43835,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -42993,7 +43975,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -43127,7 +44109,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -43203,7 +44185,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -43340,7 +44322,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -43590,7 +44572,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -43688,7 +44670,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -43813,7 +44795,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -43886,7 +44868,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -43961,7 +44943,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -44039,7 +45021,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -44112,7 +45094,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -44383,7 +45365,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -44517,7 +45499,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -44662,7 +45644,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -44831,7 +45813,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -44916,7 +45898,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -44993,7 +45975,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -45073,7 +46055,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -45151,7 +46133,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -45228,7 +46210,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -45309,7 +46291,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -45408,7 +46390,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -45494,7 +46476,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -45889,7 +46871,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46017,7 +46999,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46142,7 +47124,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46271,7 +47253,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46410,7 +47392,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46495,7 +47477,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46632,7 +47614,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46766,7 +47748,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -46895,7 +47877,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47032,7 +48014,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47109,7 +48091,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47460,7 +48442,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47542,7 +48524,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47618,7 +48600,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47696,7 +48678,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47771,7 +48753,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47845,7 +48827,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -47923,7 +48905,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48001,7 +48983,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48081,7 +49063,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48156,7 +49138,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48234,7 +49216,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48315,7 +49297,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48729,7 +49711,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48809,7 +49791,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48885,7 +49867,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -48959,7 +49941,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49036,7 +50018,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49115,7 +50097,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49190,7 +50172,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49271,7 +50253,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49560,7 +50542,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49632,7 +50614,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49710,7 +50692,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49921,7 +50903,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -49946,7 +50928,7 @@ export namespace compute_beta { /** * compute.projects.disableXpnResource - * @desc Disable a serivce resource (a.k.a service project) associated with this host project. + * @desc Disable a service resource (also known as service project) associated with this host project. * @example * * // BEFORE RUNNING: * // --------------- @@ -50050,7 +51032,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -50174,7 +51156,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -50303,7 +51285,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -50423,7 +51405,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -50545,7 +51527,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -50689,7 +51671,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -50834,7 +51816,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -50963,7 +51945,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51092,7 +52074,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51223,7 +52205,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51301,7 +52283,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51432,7 +52414,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51835,7 +52817,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -51967,7 +52949,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -52101,7 +53083,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -52248,7 +53230,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -52384,7 +53366,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -52525,7 +53507,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -52661,7 +53643,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -52986,7 +53968,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -53118,7 +54100,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -53258,7 +54240,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -53395,7 +54377,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -53540,7 +54522,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -53679,7 +54661,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -53820,7 +54802,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -53959,7 +54941,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54321,7 +55303,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54453,7 +55435,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54587,7 +55569,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54732,7 +55714,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -54810,7 +55792,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55030,7 +56012,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55108,7 +56090,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55185,7 +56167,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55258,7 +56240,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55332,7 +56314,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55410,7 +56392,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55486,7 +56468,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55566,7 +56548,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55644,7 +56626,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55719,7 +56701,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55797,7 +56779,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -55878,7 +56860,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -56278,7 +57260,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -56357,7 +57339,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -56435,105 +57417,44 @@ export namespace compute_beta { region?: string; } - export class Resource$Regioninstancegroupmanagers { + export class Resource$Regionhealthchecks { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * compute.regionInstanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // Name of the region scoping this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * compute.regionInstanceGroupManagers.abandonInstances(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regionInstanceGroupManagers.abandonInstances + * compute.regionHealthChecks.delete + * @desc Deletes the specified HealthCheck resource. + * @alias compute.regionHealthChecks.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager Name of the managed instance group. + * @param {string} params.healthCheck Name of the HealthCheck resource to delete. * @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 {().RegionInstanceGroupManagersAbandonInstancesRequest} 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 */ - abandonInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + delete( + params?: Params$Resource$Regionhealthchecks$Delete, options?: MethodOptions ): GaxiosPromise; - abandonInstances( - params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + delete( + params: Params$Resource$Regionhealthchecks$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - abandonInstances( - params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, + delete( + params: Params$Resource$Regionhealthchecks$Delete, callback: BodyResponseCallback ): void; - abandonInstances(callback: BodyResponseCallback): void; - abandonInstances( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Abandoninstances + | Params$Resource$Regionhealthchecks$Delete | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -56541,12 +57462,12 @@ export namespace compute_beta { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; + {}) as Params$Resource$Regionhealthchecks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; + params = {} as Params$Resource$Regionhealthchecks$Delete; options = {}; } @@ -56555,21 +57476,21 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances' + '/compute/beta/projects/{project}/regions/{region}/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], context: this.context, }; if (callback) { @@ -56580,52 +57501,49 @@ export namespace compute_beta { } /** - * compute.regionInstanceGroupManagers.applyUpdatesToInstances - * @desc Apply updates to selected instances the managed instance group. - * @alias compute.regionInstanceGroupManagers.applyUpdatesToInstances + * compute.regionHealthChecks.get + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. + * @alias compute.regionHealthChecks.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager The name of the managed instance group, should conform to RFC1035. + * @param {string} params.healthCheck Name of the HealthCheck resource to return. * @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 {().RegionInstanceGroupManagersApplyUpdatesRequest} params.resource Request body data + * @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 */ - applyUpdatesToInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + get( + params?: Params$Resource$Regionhealthchecks$Get, options?: MethodOptions - ): GaxiosPromise; - applyUpdatesToInstances( - params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - applyUpdatesToInstances( - params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Regionhealthchecks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - applyUpdatesToInstances( - callback: BodyResponseCallback + get( + params: Params$Resource$Regionhealthchecks$Get, + callback: BodyResponseCallback ): void; - applyUpdatesToInstances( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances - | BodyResponseCallback, + | Params$Resource$Regionhealthchecks$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances; + {}) as Params$Resource$Regionhealthchecks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances; + params = {} as Params$Resource$Regionhealthchecks$Get; options = {}; } @@ -56634,118 +57552,62 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances' + '/compute/beta/projects/{project}/regions/{region}/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.regionInstanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the instances in that group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // Name of the region scoping this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * // Name of the managed instance group to delete. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * compute.regionInstanceGroupManagers.delete(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regionInstanceGroupManagers.delete + * compute.regionHealthChecks.insert + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. + * @alias compute.regionHealthChecks.insert * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager Name of the managed instance group to delete. * @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 {().HealthCheck} 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 */ - delete( - params?: Params$Resource$Regioninstancegroupmanagers$Delete, + insert( + params?: Params$Resource$Regionhealthchecks$Insert, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Regioninstancegroupmanagers$Delete, + insert( + params: Params$Resource$Regionhealthchecks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Regioninstancegroupmanagers$Delete, + insert( + params: Params$Resource$Regionhealthchecks$Insert, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Delete + | Params$Resource$Regionhealthchecks$Insert | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -56753,12 +57615,12 @@ export namespace compute_beta { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Delete; + {}) as Params$Resource$Regionhealthchecks$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Delete; + params = {} as Params$Resource$Regionhealthchecks$Insert; options = {}; } @@ -56767,21 +57629,21 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' + '/compute/beta/projects/{project}/regions/{region}/healthChecks' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -56792,98 +57654,117 @@ export namespace compute_beta { } /** - * compute.regionInstanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // Name of the region scoping this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * compute.regionInstanceGroupManagers.deleteInstances(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); + * compute.regionHealthChecks.list + * @desc Retrieves the list of HealthCheck resources available to the specified project. + * @alias compute.regionHealthChecks.list + * @memberOf! () * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regionInstanceGroupManagers.deleteInstances + * @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$Regionhealthchecks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionhealthchecks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionhealthchecks$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionhealthchecks$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthchecks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthchecks$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/healthChecks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionHealthChecks.patch + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @alias compute.regionHealthChecks.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager Name of the managed instance group. + * @param {string} params.healthCheck Name of the HealthCheck resource to patch. * @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 {().RegionInstanceGroupManagersDeleteInstancesRequest} params.resource Request body data + * @param {().HealthCheck} 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 */ - deleteInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + patch( + params?: Params$Resource$Regionhealthchecks$Patch, options?: MethodOptions ): GaxiosPromise; - deleteInstances( - params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + patch( + params: Params$Resource$Regionhealthchecks$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteInstances( - params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, + patch( + params: Params$Resource$Regionhealthchecks$Patch, callback: BodyResponseCallback ): void; - deleteInstances(callback: BodyResponseCallback): void; - deleteInstances( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Deleteinstances + | Params$Resource$Regionhealthchecks$Patch | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -56891,12 +57772,12 @@ export namespace compute_beta { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Deleteinstances; + {}) as Params$Resource$Regionhealthchecks$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Deleteinstances; + params = {} as Params$Resource$Regionhealthchecks$Patch; options = {}; } @@ -56905,21 +57786,21 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances' + '/compute/beta/projects/{project}/regions/{region}/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], context: this.context, }; if (callback) { @@ -56930,107 +57811,51 @@ export namespace compute_beta { } /** - * compute.regionInstanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // Name of the region scoping this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * // Name of the managed instance group to return. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * compute.regionInstanceGroupManagers.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regionInstanceGroupManagers.get + * compute.regionHealthChecks.update + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. + * @alias compute.regionHealthChecks.update * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager Name of the managed instance group to return. + * @param {string} params.healthCheck Name of the HealthCheck resource to update. * @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 {().HealthCheck} 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 */ - get( - params?: Params$Resource$Regioninstancegroupmanagers$Get, + update( + params?: Params$Resource$Regionhealthchecks$Update, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Regioninstancegroupmanagers$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + update( + params: Params$Resource$Regionhealthchecks$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regioninstancegroupmanagers$Get, - callback: BodyResponseCallback + update( + params: Params$Resource$Regionhealthchecks$Update, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Get - | BodyResponseCallback, + | Params$Resource$Regionhealthchecks$Update + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Get; + {}) as Params$Resource$Regionhealthchecks$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Get; + params = {} as Params$Resource$Regionhealthchecks$Update; options = {}; } @@ -57039,52 +57864,219 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' + '/compute/beta/projects/{project}/regions/{region}/healthChecks/{healthCheck}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PUT', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region', 'healthCheck'], + pathParams: ['healthCheck', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Regionhealthchecks$Delete + extends StandardParameters { /** - * compute.regionInstanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheck resource to delete. + */ + healthCheck?: string; + /** + * 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; + } + export interface Params$Resource$Regionhealthchecks$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheck resource to return. + */ + healthCheck?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionhealthchecks$Insert + extends StandardParameters { + /** + * 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$HealthCheck; + } + export interface Params$Resource$Regionhealthchecks$List + extends StandardParameters { + /** + * 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$Regionhealthchecks$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheck resource to patch. + */ + healthCheck?: string; + /** + * 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$HealthCheck; + } + export interface Params$Resource$Regionhealthchecks$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheck resource to update. + */ + healthCheck?: string; + /** + * 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$HealthCheck; + } + + export class Resource$Regioninstancegroupmanagers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionInstanceGroupManagers.abandonInstances + * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { * var request = { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. @@ -57092,6 +58084,9 @@ export namespace compute_beta { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * + * // Name of the managed instance group. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. + * * resource: { * // TODO: Add desired properties to the request body. * }, @@ -57099,7 +58094,7 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.insert(request, function(err, response) { + * compute.regionInstanceGroupManagers.abandonInstances(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -57123,35 +58118,36 @@ export namespace compute_beta { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.insert + * @alias compute.regionInstanceGroupManagers.abandonInstances * @memberOf! () * * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager Name of the managed instance group. * @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 {().InstanceGroupManager} params.resource Request body data + * @param {().RegionInstanceGroupManagersAbandonInstancesRequest} 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$Regioninstancegroupmanagers$Insert, + abandonInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, options?: MethodOptions ): GaxiosPromise; - insert( - params: Params$Resource$Regioninstancegroupmanagers$Insert, + abandonInstances( + params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - insert( - params: Params$Resource$Regioninstancegroupmanagers$Insert, + abandonInstances( + params: Params$Resource$Regioninstancegroupmanagers$Abandoninstances, callback: BodyResponseCallback ): void; - insert(callback: BodyResponseCallback): void; - insert( + abandonInstances(callback: BodyResponseCallback): void; + abandonInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Insert + | Params$Resource$Regioninstancegroupmanagers$Abandoninstances | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -57159,12 +58155,12 @@ export namespace compute_beta { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Insert; + {}) as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Insert; + params = {} as Params$Resource$Regioninstancegroupmanagers$Abandoninstances; options = {}; } @@ -57173,21 +58169,21 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { @@ -57198,122 +58194,52 @@ export namespace compute_beta { } /** - * compute.regionInstanceGroupManagers.list - * @desc Retrieves the list of managed instance groups that are contained within the specified region. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // Name of the region scoping this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var itemsPage = response['items']; - * if (!itemsPage) { - * return; - * } - * for (var i = 0; i < itemsPage.length; i++) { - * // TODO: Change code below to process each resource in `itemsPage`: - * console.log(JSON.stringify(itemsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * compute.regionInstanceGroupManagers.list(request, handlePage); - * } - * }; - * - * compute.regionInstanceGroupManagers.list(request, handlePage); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regionInstanceGroupManagers.list + * compute.regionInstanceGroupManagers.applyUpdatesToInstances + * @desc Apply updates to selected instances the managed instance group. + * @alias compute.regionInstanceGroupManagers.applyUpdatesToInstances * @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.instanceGroupManager The name of the managed instance group, should conform to RFC1035. * @param {string} params.project Project ID for this request. - * @param {string} params.region Name of the region scoping this request. + * @param {string} params.region Name of the region scoping this request, should conform to RFC1035. + * @param {().RegionInstanceGroupManagersApplyUpdatesRequest} 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 */ - list( - params?: Params$Resource$Regioninstancegroupmanagers$List, + applyUpdatesToInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Regioninstancegroupmanagers$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + applyUpdatesToInstances( + params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regioninstancegroupmanagers$List, - callback: BodyResponseCallback + applyUpdatesToInstances( + params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + applyUpdatesToInstances( + callback: BodyResponseCallback ): void; - list( + applyUpdatesToInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$List - | BodyResponseCallback, + | Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$List; + {}) as Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$List; + params = {} as Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances; options = {}; } @@ -57322,38 +58248,33 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * compute.regionInstanceGroupManagers.listManagedInstances - * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. + * compute.regionInstanceGroupManagers.delete + * @desc Deletes the specified managed instance group and all of the instances in that group. * @example * * // BEFORE RUNNING: * // --------------- @@ -57380,34 +58301,21 @@ export namespace compute_beta { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // The name of the managed instance group. + * // Name of the managed instance group to delete. * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * auth: authClient, * }; * - * var handlePage = function(err, response) { + * compute.regionInstanceGroupManagers.delete(request, function(err, response) { * if (err) { * console.error(err); * return; * } * - * var managedInstancesPage = response['managedInstances']; - * if (!managedInstancesPage) { - * return; - * } - * for (var i = 0; i < managedInstancesPage.length; i++) { - * // TODO: Change code below to process each resource in `managedInstancesPage`: - * console.log(JSON.stringify(managedInstancesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * compute.regionInstanceGroupManagers.listManagedInstances(request, handlePage); - * } - * }; - * - * compute.regionInstanceGroupManagers.listManagedInstances(request, handlePage); + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); * }); * * function authorize(callback) { @@ -57423,71 +58331,48 @@ export namespace compute_beta { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.listManagedInstances + * @alias compute.regionInstanceGroupManagers.delete * @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 {string} params.instanceGroupManager The name of the managed instance group. - * @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.instanceGroupManager Name of the managed instance group to delete. * @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 {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 */ - listManagedInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, + delete( + params?: Params$Resource$Regioninstancegroupmanagers$Delete, options?: MethodOptions - ): GaxiosPromise; - listManagedInstances( - params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, - options: - | MethodOptions - | BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - >, - callback: BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - > - ): void; - listManagedInstances( - params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, - callback: BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - > + ): GaxiosPromise; + delete( + params: Params$Resource$Regioninstancegroupmanagers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listManagedInstances( - callback: BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - > + delete( + params: Params$Resource$Regioninstancegroupmanagers$Delete, + callback: BodyResponseCallback ): void; - listManagedInstances( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances - | BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - >, + | Params$Resource$Regioninstancegroupmanagers$Delete + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - >, - callback?: BodyResponseCallback< - Schema$RegionInstanceGroupManagersListInstancesResponse - > - ): void | GaxiosPromise< - Schema$RegionInstanceGroupManagersListInstancesResponse - > { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; + {}) as Params$Resource$Regioninstancegroupmanagers$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; + params = {} as Params$Resource$Regioninstancegroupmanagers$Delete; options = {}; } @@ -57496,15 +58381,15 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', }, options ), @@ -57514,19 +58399,15 @@ export namespace compute_beta { context: this.context, }; if (callback) { - createAPIRequest< - Schema$RegionInstanceGroupManagersListInstancesResponse - >(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest< - Schema$RegionInstanceGroupManagersListInstancesResponse - >(parameters); + return createAPIRequest(parameters); } } /** - * compute.regionInstanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * compute.regionInstanceGroupManagers.deleteInstances + * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -57553,18 +58434,17 @@ export namespace compute_beta { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // The name of the instance group manager. + * // Name of the managed instance group. * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. + * // TODO: Add desired properties to the request body. * }, * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.patch(request, function(err, response) { + * compute.regionInstanceGroupManagers.deleteInstances(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -57588,36 +58468,36 @@ export namespace compute_beta { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.patch + * @alias compute.regionInstanceGroupManagers.deleteInstances * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager The name of the instance group manager. + * @param {string} params.instanceGroupManager Name of the managed instance group. * @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 {().InstanceGroupManager} params.resource Request body data + * @param {().RegionInstanceGroupManagersDeleteInstancesRequest} 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$Regioninstancegroupmanagers$Patch, + deleteInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Regioninstancegroupmanagers$Patch, + deleteInstances( + params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Regioninstancegroupmanagers$Patch, + deleteInstances( + params: Params$Resource$Regioninstancegroupmanagers$Deleteinstances, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + deleteInstances(callback: BodyResponseCallback): void; + deleteInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Patch + | Params$Resource$Regioninstancegroupmanagers$Deleteinstances | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -57625,12 +58505,12 @@ export namespace compute_beta { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Patch; + {}) as Params$Resource$Regioninstancegroupmanagers$Deleteinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Patch; + params = {} as Params$Resource$Regioninstancegroupmanagers$Deleteinstances; options = {}; } @@ -57639,15 +58519,15 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', }, options ), @@ -57664,8 +58544,8 @@ export namespace compute_beta { } /** - * compute.regionInstanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * compute.regionInstanceGroupManagers.get + * @desc Returns all of the details about the specified managed instance group. * @example * * // BEFORE RUNNING: * // --------------- @@ -57692,17 +58572,13 @@ export namespace compute_beta { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // Name of the managed instance group. + * // Name of the managed instance group to return. * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.recreateInstances(request, function(err, response) { + * compute.regionInstanceGroupManagers.get(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -57726,49 +58602,49 @@ export namespace compute_beta { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.recreateInstances + * @alias compute.regionInstanceGroupManagers.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager Name of the managed instance group. + * @param {string} params.instanceGroupManager Name of the managed instance group to return. * @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 {().RegionInstanceGroupManagersRecreateRequest} 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 */ - recreateInstances( - params?: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, + get( + params?: Params$Resource$Regioninstancegroupmanagers$Get, options?: MethodOptions - ): GaxiosPromise; - recreateInstances( - params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Regioninstancegroupmanagers$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recreateInstances( - params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, - callback: BodyResponseCallback + get( + params: Params$Resource$Regioninstancegroupmanagers$Get, + callback: BodyResponseCallback ): void; - recreateInstances(callback: BodyResponseCallback): void; - recreateInstances( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Recreateinstances - | BodyResponseCallback, + | Params$Resource$Regioninstancegroupmanagers$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; + {}) as Params$Resource$Regioninstancegroupmanagers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; + params = {} as Params$Resource$Regioninstancegroupmanagers$Get; options = {}; } @@ -57777,15 +58653,15 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), @@ -57795,15 +58671,15 @@ export namespace compute_beta { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.regionInstanceGroupManagers.resize - * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. + * compute.regionInstanceGroupManagers.insert + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. * @example * * // BEFORE RUNNING: * // --------------- @@ -57830,16 +58706,14 @@ export namespace compute_beta { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. - * - * // Number of instances that should exist in this instance group manager. - * size: 0, // TODO: Update placeholder value. + * resource: { + * // TODO: Add desired properties to the request body. + * }, * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.resize(request, function(err, response) { + * compute.regionInstanceGroupManagers.insert(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -57863,36 +58737,35 @@ export namespace compute_beta { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.resize + * @alias compute.regionInstanceGroupManagers.insert * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager Name of the managed instance group. * @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 {integer} params.size Number of instances that should exist in this instance group manager. + * @param {().InstanceGroupManager} 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 */ - resize( - params?: Params$Resource$Regioninstancegroupmanagers$Resize, + insert( + params?: Params$Resource$Regioninstancegroupmanagers$Insert, options?: MethodOptions ): GaxiosPromise; - resize( - params: Params$Resource$Regioninstancegroupmanagers$Resize, + insert( + params: Params$Resource$Regioninstancegroupmanagers$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resize( - params: Params$Resource$Regioninstancegroupmanagers$Resize, + insert( + params: Params$Resource$Regioninstancegroupmanagers$Insert, callback: BodyResponseCallback ): void; - resize(callback: BodyResponseCallback): void; - resize( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Resize + | Params$Resource$Regioninstancegroupmanagers$Insert | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -57900,12 +58773,12 @@ export namespace compute_beta { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Resize; + {}) as Params$Resource$Regioninstancegroupmanagers$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Resize; + params = {} as Params$Resource$Regioninstancegroupmanagers$Insert; options = {}; } @@ -57914,21 +58787,21 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager', 'size'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -57939,8 +58812,8 @@ export namespace compute_beta { } /** - * compute.regionInstanceGroupManagers.setAutoHealingPolicies - * @desc Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Please use Patch instead. + * compute.regionInstanceGroupManagers.list + * @desc Retrieves the list of managed instance groups that are contained within the specified region. * @example * * // BEFORE RUNNING: * // --------------- @@ -57967,25 +58840,31 @@ export namespace compute_beta { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // Name of the managed instance group. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.setAutoHealingPolicies(request, function(err, response) { + * var handlePage = function(err, response) { * if (err) { * console.error(err); * return; * } * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); + * var itemsPage = response['items']; + * if (!itemsPage) { + * return; + * } + * for (var i = 0; i < itemsPage.length; i++) { + * // TODO: Change code below to process each resource in `itemsPage`: + * console.log(JSON.stringify(itemsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * compute.regionInstanceGroupManagers.list(request, handlePage); + * } + * }; + * + * compute.regionInstanceGroupManagers.list(request, handlePage); * }); * * function authorize(callback) { @@ -58001,51 +58880,54 @@ export namespace compute_beta { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.setAutoHealingPolicies + * @alias compute.regionInstanceGroupManagers.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager Name of the managed instance group. + * @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 {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 {().RegionInstanceGroupManagersSetAutoHealingRequest} 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 */ - setAutoHealingPolicies( - params?: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + list( + params?: Params$Resource$Regioninstancegroupmanagers$List, options?: MethodOptions - ): GaxiosPromise; - setAutoHealingPolicies( - params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Regioninstancegroupmanagers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setAutoHealingPolicies( - params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, - callback: BodyResponseCallback + list( + params: Params$Resource$Regioninstancegroupmanagers$List, + callback: BodyResponseCallback ): void; - setAutoHealingPolicies( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - setAutoHealingPolicies( + list( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies - | BodyResponseCallback, + | Params$Resource$Regioninstancegroupmanagers$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; + {}) as Params$Resource$Regioninstancegroupmanagers$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; + params = {} as Params$Resource$Regioninstancegroupmanagers$List; options = {}; } @@ -58054,33 +58936,38 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], - pathParams: ['instanceGroupManager', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * compute.regionInstanceGroupManagers.setInstanceTemplate - * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. + * compute.regionInstanceGroupManagers.listManagedInstances + * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. * @example * * // BEFORE RUNNING: * // --------------- @@ -58110,22 +58997,31 @@ export namespace compute_beta { * // The name of the managed instance group. * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.setInstanceTemplate(request, function(err, response) { + * var handlePage = function(err, response) { * if (err) { * console.error(err); * return; * } * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); + * var managedInstancesPage = response['managedInstances']; + * if (!managedInstancesPage) { + * return; + * } + * for (var i = 0; i < managedInstancesPage.length; i++) { + * // TODO: Change code below to process each resource in `managedInstancesPage`: + * console.log(JSON.stringify(managedInstancesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * compute.regionInstanceGroupManagers.listManagedInstances(request, handlePage); + * } + * }; + * + * compute.regionInstanceGroupManagers.listManagedInstances(request, handlePage); * }); * * function authorize(callback) { @@ -58141,49 +59037,71 @@ export namespace compute_beta { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.setInstanceTemplate + * @alias compute.regionInstanceGroupManagers.listManagedInstances * @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 {string} params.instanceGroupManager The name of the managed instance group. + * @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 {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 {().RegionInstanceGroupManagersSetTemplateRequest} 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 */ - setInstanceTemplate( - params?: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + listManagedInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, options?: MethodOptions - ): GaxiosPromise; - setInstanceTemplate( - params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + listManagedInstances( + params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, + options: + | MethodOptions + | BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstancesResponse + >, + callback: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstancesResponse + > ): void; - setInstanceTemplate( - params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, - callback: BodyResponseCallback + listManagedInstances( + params: Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances, + callback: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstancesResponse + > ): void; - setInstanceTemplate(callback: BodyResponseCallback): void; - setInstanceTemplate( + listManagedInstances( + callback: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstancesResponse + > + ): void; + listManagedInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate - | BodyResponseCallback, + | Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances + | BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstancesResponse + >, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstancesResponse + >, + callback?: BodyResponseCallback< + Schema$RegionInstanceGroupManagersListInstancesResponse + > + ): void | GaxiosPromise< + Schema$RegionInstanceGroupManagersListInstancesResponse + > { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; + {}) as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; + params = {} as Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances; options = {}; } @@ -58192,13 +59110,13 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -58210,15 +59128,19 @@ export namespace compute_beta { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest< + Schema$RegionInstanceGroupManagersListInstancesResponse + >(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest< + Schema$RegionInstanceGroupManagersListInstancesResponse + >(parameters); } } /** - * compute.regionInstanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. + * compute.regionInstanceGroupManagers.patch + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -58245,17 +59167,18 @@ export namespace compute_beta { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // Name of the managed instance group. + * // The name of the instance group manager. * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { - * // TODO: Add desired properties to the request body. + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. * }, * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.setTargetPools(request, function(err, response) { + * compute.regionInstanceGroupManagers.patch(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -58279,36 +59202,36 @@ export namespace compute_beta { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.setTargetPools + * @alias compute.regionInstanceGroupManagers.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager Name of the managed instance group. + * @param {string} params.instanceGroupManager The name of the instance group manager. * @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 {().RegionInstanceGroupManagersSetTargetPoolsRequest} params.resource Request body data + * @param {().InstanceGroupManager} 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 */ - setTargetPools( - params?: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + patch( + params?: Params$Resource$Regioninstancegroupmanagers$Patch, options?: MethodOptions ): GaxiosPromise; - setTargetPools( - params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + patch( + params: Params$Resource$Regioninstancegroupmanagers$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setTargetPools( - params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + patch( + params: Params$Resource$Regioninstancegroupmanagers$Patch, callback: BodyResponseCallback ): void; - setTargetPools(callback: BodyResponseCallback): void; - setTargetPools( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Settargetpools + | Params$Resource$Regioninstancegroupmanagers$Patch | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -58316,12 +59239,12 @@ export namespace compute_beta { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + {}) as Params$Resource$Regioninstancegroupmanagers$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + params = {} as Params$Resource$Regioninstancegroupmanagers$Patch; options = {}; } @@ -58330,15 +59253,15 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', }, options ), @@ -58355,8 +59278,8 @@ export namespace compute_beta { } /** - * compute.regionInstanceGroupManagers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * compute.regionInstanceGroupManagers.recreateInstances + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. * @example * * // BEFORE RUNNING: * // --------------- @@ -58380,11 +59303,11 @@ export namespace compute_beta { * // Project ID for this request. * project: 'my-project', // TODO: Update placeholder value. * - * // The name of the region for this request. + * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // Name of the resource for this request. - * resource_: 'my-resource', // TODO: Update placeholder value. + * // Name of the managed instance group. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * * resource: { * // TODO: Add desired properties to the request body. @@ -58393,7 +59316,7 @@ export namespace compute_beta { * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.testIamPermissions(request, function(err, response) { + * compute.regionInstanceGroupManagers.recreateInstances(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -58417,52 +59340,49 @@ export namespace compute_beta { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.testIamPermissions + * @alias compute.regionInstanceGroupManagers.recreateInstances * @memberOf! () * * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager Name of the managed instance group. * @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 or id of the resource for this request. - * @param {().TestPermissionsRequest} params.resource Request body data + * @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 {().RegionInstanceGroupManagersRecreateRequest} 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$Regioninstancegroupmanagers$Testiampermissions, + recreateInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, - callback: BodyResponseCallback + ): GaxiosPromise; + recreateInstances( + params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + recreateInstances( + params: Params$Resource$Regioninstancegroupmanagers$Recreateinstances, + callback: BodyResponseCallback ): void; - testIamPermissions( + recreateInstances(callback: BodyResponseCallback): void; + recreateInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Testiampermissions - | BodyResponseCallback, + | Params$Resource$Regioninstancegroupmanagers$Recreateinstances + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Testiampermissions; + {}) as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Testiampermissions; + params = {} as Params$Resource$Regioninstancegroupmanagers$Recreateinstances; options = {}; } @@ -58471,33 +59391,33 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{resource}/testIamPermissions' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.regionInstanceGroupManagers.update - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. + * compute.regionInstanceGroupManagers.resize + * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. * @example * * // BEFORE RUNNING: * // --------------- @@ -58524,18 +59444,16 @@ export namespace compute_beta { * // Name of the region scoping this request. * region: 'my-region', // TODO: Update placeholder value. * - * // The name of the instance group manager. + * // Name of the managed instance group. * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, + * // Number of instances that should exist in this instance group manager. + * size: 0, // TODO: Update placeholder value. * * auth: authClient, * }; * - * compute.regionInstanceGroupManagers.update(request, function(err, response) { + * compute.regionInstanceGroupManagers.resize(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -58559,36 +59477,36 @@ export namespace compute_beta { * callback(authClient); * }); * } - * @alias compute.regionInstanceGroupManagers.update + * @alias compute.regionInstanceGroupManagers.resize * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager The name of the instance group manager. + * @param {string} params.instanceGroupManager Name of the managed instance group. * @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 {().InstanceGroupManager} params.resource Request body data + * @param {integer} params.size Number of instances that should exist in this instance group manager. * @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 */ - update( - params?: Params$Resource$Regioninstancegroupmanagers$Update, + resize( + params?: Params$Resource$Regioninstancegroupmanagers$Resize, options?: MethodOptions ): GaxiosPromise; - update( - params: Params$Resource$Regioninstancegroupmanagers$Update, + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Regioninstancegroupmanagers$Update, + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, callback: BodyResponseCallback ): void; - update(callback: BodyResponseCallback): void; - update( + resize(callback: BodyResponseCallback): void; + resize( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Update + | Params$Resource$Regioninstancegroupmanagers$Resize | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -58596,12 +59514,12 @@ export namespace compute_beta { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Update; + {}) as Params$Resource$Regioninstancegroupmanagers$Resize; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Update; + params = {} as Params$Resource$Regioninstancegroupmanagers$Resize; options = {}; } @@ -58610,20 +59528,20 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', + method: 'POST', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager'], + requiredParams: ['project', 'region', 'instanceGroupManager', 'size'], pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; @@ -58633,136 +59551,3143 @@ export namespace compute_beta { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Regioninstancegroupmanagers$Abandoninstances - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the managed instance group. - */ - instanceGroupManager?: string; - /** - * 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$RegionInstanceGroupManagersAbandonInstancesRequest; - } - export interface Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - + * compute.regionInstanceGroupManagers.setAutoHealingPolicies + * @desc Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Please use Patch instead. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // Name of the region scoping this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * // Name of the managed instance group. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * compute.regionInstanceGroupManagers.setAutoHealingPolicies(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regionInstanceGroupManagers.setAutoHealingPolicies + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager Name of the managed instance group. + * @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 {().RegionInstanceGroupManagersSetAutoHealingRequest} 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 + */ + setAutoHealingPolicies( + params?: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + options?: MethodOptions + ): GaxiosPromise; + setAutoHealingPolicies( + params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setAutoHealingPolicies( + params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + callback: BodyResponseCallback + ): void; + setAutoHealingPolicies( + callback: BodyResponseCallback + ): void; + setAutoHealingPolicies( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionInstanceGroupManagers.setInstanceTemplate + * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // Name of the region scoping this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * // The name of the managed instance group. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * compute.regionInstanceGroupManagers.setInstanceTemplate(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regionInstanceGroupManagers.setInstanceTemplate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager The name of the managed instance group. + * @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 {().RegionInstanceGroupManagersSetTemplateRequest} 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 + */ + setInstanceTemplate( + params?: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + options?: MethodOptions + ): GaxiosPromise; + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + callback: BodyResponseCallback + ): void; + setInstanceTemplate(callback: BodyResponseCallback): void; + setInstanceTemplate( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionInstanceGroupManagers.setTargetPools + * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // Name of the region scoping this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * // Name of the managed instance group. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * compute.regionInstanceGroupManagers.setTargetPools(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regionInstanceGroupManagers.setTargetPools + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager Name of the managed instance group. + * @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 {().RegionInstanceGroupManagersSetTargetPoolsRequest} 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 + */ + setTargetPools( + params?: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + options?: MethodOptions + ): GaxiosPromise; + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + callback: BodyResponseCallback + ): void; + setTargetPools(callback: BodyResponseCallback): void; + setTargetPools( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Settargetpools + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionInstanceGroupManagers.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // The name of the region for this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * // Name of the resource for this request. + * resource_: 'my-resource', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * compute.regionInstanceGroupManagers.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regionInstanceGroupManagers.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 or id 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$Regioninstancegroupmanagers$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regioninstancegroupmanagers$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionInstanceGroupManagers.update + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // Name of the region scoping this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * // The name of the instance group manager. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * compute.regionInstanceGroupManagers.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regionInstanceGroupManagers.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager The name of the instance group manager. + * @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 {().InstanceGroupManager} 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 + */ + update( + params?: Params$Resource$Regioninstancegroupmanagers$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Regioninstancegroupmanagers$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Regioninstancegroupmanagers$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regioninstancegroupmanagers$Abandoninstances + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * 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$RegionInstanceGroupManagersAbandonInstancesRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group, should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request, should conform to RFC1035. + */ + region?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersApplyUpdatesRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group to delete. + */ + instanceGroupManager?: string; + /** + * 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; + } + export interface Params$Resource$Regioninstancegroupmanagers$Deleteinstances + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * 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$RegionInstanceGroupManagersDeleteInstancesRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group to return. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regioninstancegroupmanagers$Insert + extends StandardParameters { + /** + * 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$InstanceGroupManager; + } + export interface Params$Resource$Regioninstancegroupmanagers$List + extends StandardParameters { + /** + * 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$Regioninstancegroupmanagers$Listmanagedinstances + extends StandardParameters { + /** + * 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 name of the managed instance group. + */ + 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; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regioninstancegroupmanagers$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the instance group manager. + */ + instanceGroupManager?: string; + /** + * 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$InstanceGroupManager; + } + export interface Params$Resource$Regioninstancegroupmanagers$Recreateinstances + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * 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$RegionInstanceGroupManagersRecreateRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Resize + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * 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; + /** + * Number of instances that should exist in this instance group manager. + */ + size?: number; + } + export interface Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * 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$RegionInstanceGroupManagersSetAutoHealingRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * 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$RegionInstanceGroupManagersSetTemplateRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Settargetpools + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * 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$RegionInstanceGroupManagersSetTargetPoolsRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Testiampermissions + extends StandardParameters { + /** + * 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 or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the instance group manager. + */ + instanceGroupManager?: string; + /** + * 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$InstanceGroupManager; + } + + export class Resource$Regioninstancegroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionInstanceGroups.get + * @desc Returns the specified instance group resource. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // Name of the region scoping this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * // Name of the instance group resource to return. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * compute.regionInstanceGroups.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regionInstanceGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroup Name of the instance group resource to return. + * @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 + */ + get( + params?: Params$Resource$Regioninstancegroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regioninstancegroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regioninstancegroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regioninstancegroups$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroups/{instanceGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionInstanceGroups.list + * @desc Retrieves the list of instance group resources contained within the specified region. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // Name of the region scoping this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var itemsPage = response['items']; + * if (!itemsPage) { + * return; + * } + * for (var i = 0; i < itemsPage.length; i++) { + * // TODO: Change code below to process each resource in `itemsPage`: + * console.log(JSON.stringify(itemsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * compute.regionInstanceGroups.list(request, handlePage); + * } + * }; + * + * compute.regionInstanceGroups.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regionInstanceGroups.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$Regioninstancegroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regioninstancegroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regioninstancegroups$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regioninstancegroups$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionInstanceGroups.listInstances + * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // Name of the region scoping this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * // Name of the regional instance group for which we want to list the instances. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var itemsPage = response['items']; + * if (!itemsPage) { + * return; + * } + * for (var i = 0; i < itemsPage.length; i++) { + * // TODO: Change code below to process each resource in `itemsPage`: + * console.log(JSON.stringify(itemsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * compute.regionInstanceGroups.listInstances(request, handlePage); + * } + * }; + * + * compute.regionInstanceGroups.listInstances(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regionInstanceGroups.listInstances + * @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 {string} params.instanceGroup Name of the regional instance group for which we want to list the instances. + * @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 {().RegionInstanceGroupsListInstancesRequest} 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 + */ + listInstances( + params?: Params$Resource$Regioninstancegroups$Listinstances, + options?: MethodOptions + ): GaxiosPromise; + listInstances( + params: Params$Resource$Regioninstancegroups$Listinstances, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listInstances( + params: Params$Resource$Regioninstancegroups$Listinstances, + callback: BodyResponseCallback + ): void; + listInstances( + callback: BodyResponseCallback + ): void; + listInstances( + paramsOrCallback?: + | Params$Resource$Regioninstancegroups$Listinstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroups$Listinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroups$Listinstances; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.regionInstanceGroups.setNamedPorts + * @desc Sets the named ports for the specified regional instance group. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // Name of the region scoping this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * // The name of the regional instance group where the named ports are updated. + * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * compute.regionInstanceGroups.setNamedPorts(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regionInstanceGroups.setNamedPorts + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroup The name of the regional instance group where the named ports are updated. + * @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 {().RegionInstanceGroupsSetNamedPortsRequest} 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 + */ + setNamedPorts( + params?: Params$Resource$Regioninstancegroups$Setnamedports, + options?: MethodOptions + ): GaxiosPromise; + setNamedPorts( + params: Params$Resource$Regioninstancegroups$Setnamedports, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setNamedPorts( + params: Params$Resource$Regioninstancegroups$Setnamedports, + callback: BodyResponseCallback + ): void; + setNamedPorts(callback: BodyResponseCallback): void; + setNamedPorts( + paramsOrCallback?: + | Params$Resource$Regioninstancegroups$Setnamedports + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroups$Setnamedports; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroups$Setnamedports; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroup'], + pathParams: ['instanceGroup', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionInstanceGroups.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // The name of the region for this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * // Name of the resource for this request. + * resource_: 'my-resource', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * compute.regionInstanceGroups.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regionInstanceGroups.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 or id 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$Regioninstancegroups$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regioninstancegroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regioninstancegroups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regioninstancegroups$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroups$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroups/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regioninstancegroups$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance group resource to return. + */ + instanceGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regioninstancegroups$List + extends StandardParameters { + /** + * 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$Regioninstancegroups$Listinstances + extends StandardParameters { + /** + * 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; + /** + * Name of the regional instance group for which we want to list the instances. + */ + instanceGroup?: 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; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupsListInstancesRequest; + } + export interface Params$Resource$Regioninstancegroups$Setnamedports + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the regional instance group where the named ports are updated. + */ + instanceGroup?: string; + /** + * 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$RegionInstanceGroupsSetNamedPortsRequest; + } + export interface Params$Resource$Regioninstancegroups$Testiampermissions + extends StandardParameters { + /** + * 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 or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Regionoperations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionOperations.delete + * @desc Deletes the specified region-specific Operations resource. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // Name of the region for this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * // Name of the Operations resource to delete. + * operation: 'my-operation', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * compute.regionOperations.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regionOperations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to delete. + * @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 + */ + delete( + params?: Params$Resource$Regionoperations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionoperations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionoperations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionoperations$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionoperations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionoperations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/operations/{operation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'operation'], + pathParams: ['operation', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** - * The name of the managed instance group, should conform to RFC1035. + * compute.regionOperations.get + * @desc Retrieves the specified region-specific Operations resource. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // Name of the region for this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * // Name of the Operations resource to return. + * operation: 'my-operation', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * compute.regionOperations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regionOperations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Name of the Operations resource to return. + * @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 */ - instanceGroupManager?: string; + get( + params?: Params$Resource$Regionoperations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionoperations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionoperations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionoperations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionoperations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionoperations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/operations/{operation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'operation'], + pathParams: ['operation', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionOperations.list + * @desc Retrieves a list of Operation resources contained within the specified region. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // Name of the region for this request. + * region: 'my-region', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var itemsPage = response['items']; + * if (!itemsPage) { + * return; + * } + * for (var i = 0; i < itemsPage.length; i++) { + * // TODO: Change code below to process each resource in `itemsPage`: + * console.log(JSON.stringify(itemsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * compute.regionOperations.list(request, handlePage); + * } + * }; + * + * compute.regionOperations.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regionOperations.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$Regionoperations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionoperations$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionoperations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionoperations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionoperations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionoperations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/operations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionoperations$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the Operations resource to delete. + */ + operation?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request, should conform to RFC1035. + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regionoperations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the Operations resource to return. + */ + operation?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regionoperations$List + extends StandardParameters { + /** + * 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 class Resource$Regions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regions.get + * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // Name of the region resource to return. + * region: 'my-region', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * compute.regions.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regions.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 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$Regions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regions$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Regions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/beta/projects/{project}/regions/{region}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regions.list + * @desc Retrieves the list of region resources available to the specified project. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('beta'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var itemsPage = response['items']; + * if (!itemsPage) { + * return; + * } + * for (var i = 0; i < itemsPage.length; i++) { + * // TODO: Change code below to process each resource in `itemsPage`: + * console.log(JSON.stringify(itemsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * compute.regions.list(request, handlePage); + * } + * }; + * + * compute.regions.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.regions.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 {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 */ - region?: string; + list( + params?: Params$Resource$Regions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regions$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regions$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regions$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Regions$List; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupManagersApplyUpdatesRequest; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/compute/beta/projects/{project}/regions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } - export interface Params$Resource$Regioninstancegroupmanagers$Delete - extends StandardParameters { + + export interface Params$Resource$Regions$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - /** - * Name of the managed instance group to delete. - */ - instanceGroupManager?: string; /** * Project ID for this request. */ project?: string; /** - * Name of the region scoping this request. + * Name of the region resource to return. */ 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$Regioninstancegroupmanagers$Deleteinstances - extends StandardParameters { + export interface Params$Resource$Regions$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the managed instance group. + * 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). */ - instanceGroupManager?: 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; /** - * Name of the region scoping this request. + * 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. */ - region?: string; + orderBy?: 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). + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. */ - requestId?: string; - + pageToken?: string; /** - * Request body metadata + * Project ID for this request. */ - requestBody?: Schema$RegionInstanceGroupManagersDeleteInstancesRequest; + project?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Get - extends StandardParameters { + + export class Resource$Regionsslcertificates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + /** - * Auth client or API Key for the request + * 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 */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + delete( + params?: Params$Resource$Regionsslcertificates$Delete, + options?: MethodOptions + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/sslCertificates/{sslCertificate}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'sslCertificate'], + pathParams: ['project', 'region', 'sslCertificate'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } /** - * Name of the managed instance group to return. + * 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 */ - instanceGroupManager?: string; + get( + params?: Params$Resource$Regionsslcertificates$Get, + options?: MethodOptions + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/sslCertificates/{sslCertificate}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'sslCertificate'], + pathParams: ['project', 'region', 'sslCertificate'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** - * Project ID for this request. + * 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 */ - project?: string; + insert( + params?: Params$Resource$Regionsslcertificates$Insert, + options?: MethodOptions + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/sslCertificates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** - * Name of the region scoping this request. + * 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 */ - region?: string; + list( + params?: Params$Resource$Regionsslcertificates$List, + options?: MethodOptions + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/sslCertificates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } - export interface Params$Resource$Regioninstancegroupmanagers$Insert + + export interface Params$Resource$Regionsslcertificates$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -58781,35 +62706,18 @@ export namespace compute_beta { * 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 + * Name of the SslCertificate resource to delete. */ - requestBody?: Schema$InstanceGroupManager; + sslCertificate?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$List + export interface Params$Resource$Regionsslcertificates$Get extends StandardParameters { /** * 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. */ @@ -58818,54 +62726,18 @@ export namespace compute_beta { * Name of the region scoping this request. */ region?: string; - } - export interface Params$Resource$Regioninstancegroupmanagers$Listmanagedinstances - extends StandardParameters { - /** - * 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 name of the managed instance group. - */ - 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; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region scoping this request. + * Name of the SslCertificate resource to return. */ - region?: string; + sslCertificate?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Patch + export interface Params$Resource$Regionsslcertificates$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - /** - * The name of the instance group manager. - */ - instanceGroupManager?: string; /** * Project ID for this request. */ @@ -58882,9 +62754,9 @@ export namespace compute_beta { /** * Request body metadata */ - requestBody?: Schema$InstanceGroupManager; + requestBody?: Schema$SslCertificate; } - export interface Params$Resource$Regioninstancegroupmanagers$Recreateinstances + export interface Params$Resource$Regionsslcertificates$List extends StandardParameters { /** * Auth client or API Key for the request @@ -58892,9 +62764,21 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the managed instance group. + * 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. */ - instanceGroupManager?: string; + pageToken?: string; /** * Project ID for this request. */ @@ -58903,55 +62787,409 @@ export namespace compute_beta { * 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$RegionInstanceGroupManagersRecreateRequest; } - export interface Params$Resource$Regioninstancegroupmanagers$Resize - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + export class Resource$Regiontargethttpproxies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Name of the managed instance group. + * 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 */ - instanceGroupManager?: string; + delete( + params?: Params$Resource$Regiontargethttpproxies$Delete, + options?: MethodOptions + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpProxy'], + pathParams: ['project', 'region', 'targetHttpProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** - * Project ID for this request. + * 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 */ - project?: string; + get( + params?: Params$Resource$Regiontargethttpproxies$Get, + options?: MethodOptions + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpProxy'], + pathParams: ['project', 'region', 'targetHttpProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** - * Name of the region scoping this request. + * 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 */ - region?: string; + insert( + params?: Params$Resource$Regiontargethttpproxies$Insert, + options?: MethodOptions + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/targetHttpProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** - * 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). + * 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 */ - requestId?: string; + list( + params?: Params$Resource$Regiontargethttpproxies$List, + options?: MethodOptions + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/targetHttpProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** - * Number of instances that should exist in this instance group manager. + * 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 */ - size?: number; + setUrlMap( + params?: Params$Resource$Regiontargethttpproxies$Seturlmap, + options?: MethodOptions + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpProxy'], + pathParams: ['project', 'region', 'targetHttpProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } - export interface Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies + + export interface Params$Resource$Regiontargethttpproxies$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - /** - * Name of the managed instance group. - */ - instanceGroupManager?: string; /** * Project ID for this request. */ @@ -58964,23 +63202,18 @@ export namespace compute_beta { * 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 + * Name of the TargetHttpProxy resource to delete. */ - requestBody?: Schema$RegionInstanceGroupManagersSetAutoHealingRequest; + targetHttpProxy?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate + export interface Params$Resource$Regiontargethttpproxies$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - /** - * The name of the managed instance group. - */ - instanceGroupManager?: string; /** * Project ID for this request. */ @@ -58990,26 +63223,17 @@ export namespace compute_beta { */ 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 + * Name of the TargetHttpProxy resource to return. */ - requestBody?: Schema$RegionInstanceGroupManagersSetTemplateRequest; + targetHttpProxy?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Settargetpools + export interface Params$Resource$Regiontargethttpproxies$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - /** - * Name of the managed instance group. - */ - instanceGroupManager?: string; /** * Project ID for this request. */ @@ -59026,9 +63250,9 @@ export namespace compute_beta { /** * Request body metadata */ - requestBody?: Schema$RegionInstanceGroupManagersSetTargetPoolsRequest; + requestBody?: Schema$TargetHttpProxy; } - export interface Params$Resource$Regioninstancegroupmanagers$Testiampermissions + export interface Params$Resource$Regiontargethttpproxies$List extends StandardParameters { /** * Auth client or API Key for the request @@ -59036,34 +63260,37 @@ export namespace compute_beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Project ID for this request. + * 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). */ - project?: string; + filter?: string; /** - * The name of the region 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) */ - region?: string; + maxResults?: number; /** - * Name or id of the resource for this request. + * 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. */ - resource?: 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$TestPermissionsRequest; + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; } - export interface Params$Resource$Regioninstancegroupmanagers$Update + export interface Params$Resource$Regiontargethttpproxies$Seturlmap extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - /** - * The name of the instance group manager. - */ - instanceGroupManager?: string; /** * Project ID for this request. */ @@ -59076,119 +63303,144 @@ export namespace compute_beta { * 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$InstanceGroupManager; + requestBody?: Schema$UrlMapReference; } - export class Resource$Regioninstancegroups { + export class Resource$Regiontargethttpsproxies { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * compute.regionInstanceGroups.get - * @desc Returns the specified instance group resource. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // Name of the region scoping this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * // Name of the instance group resource to return. - * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * compute.regionInstanceGroups.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); + * compute.regionTargetHttpsProxies.delete + * @desc Deletes the specified TargetHttpsProxy resource. + * @alias compute.regionTargetHttpsProxies.delete + * @memberOf! () * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regionInstanceGroups.get + * @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 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$Regiontargethttpsproxies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regiontargethttpsproxies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regiontargethttpsproxies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regiontargethttpsproxies$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regiontargethttpsproxies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpsproxies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'targetHttpsProxy'], + pathParams: ['project', 'region', 'targetHttpsProxy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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.regionTargetHttpsProxies.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroup Name of the instance group resource to return. * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request. + * @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$Regioninstancegroups$Get, + params?: Params$Resource$Regiontargethttpsproxies$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Regioninstancegroups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regiontargethttpsproxies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Regioninstancegroups$Get, - callback: BodyResponseCallback + params: Params$Resource$Regiontargethttpsproxies$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Regioninstancegroups$Get - | BodyResponseCallback, + | Params$Resource$Regiontargethttpsproxies$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroups$Get; + {}) as Params$Resource$Regiontargethttpsproxies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroups$Get; + params = {} as Params$Resource$Regiontargethttpsproxies$Get; options = {}; } @@ -59197,145 +63449,75 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroups/{instanceGroup}' + '/compute/beta/projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroup'], - pathParams: ['instanceGroup', 'project', 'region'], + requiredParams: ['project', 'region', 'targetHttpsProxy'], + pathParams: ['project', 'region', 'targetHttpsProxy'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.regionInstanceGroups.list - * @desc Retrieves the list of instance group resources contained within the specified region. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // Name of the region scoping this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var itemsPage = response['items']; - * if (!itemsPage) { - * return; - * } - * for (var i = 0; i < itemsPage.length; i++) { - * // TODO: Change code below to process each resource in `itemsPage`: - * console.log(JSON.stringify(itemsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * compute.regionInstanceGroups.list(request, handlePage); - * } - * }; - * - * compute.regionInstanceGroups.list(request, handlePage); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regionInstanceGroups.list + * compute.regionTargetHttpsProxies.insert + * @desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. + * @alias compute.regionTargetHttpsProxies.insert * @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 {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 {().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 */ - list( - params?: Params$Resource$Regioninstancegroups$List, + insert( + params?: Params$Resource$Regiontargethttpsproxies$Insert, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Regioninstancegroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + insert( + params: Params$Resource$Regiontargethttpsproxies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regioninstancegroups$List, - callback: BodyResponseCallback + insert( + params: Params$Resource$Regiontargethttpsproxies$Insert, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Regioninstancegroups$List - | BodyResponseCallback, + | Params$Resource$Regiontargethttpsproxies$Insert + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroups$List; + {}) as Params$Resource$Regiontargethttpsproxies$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroups$List; + params = {} as Params$Resource$Regiontargethttpsproxies$Insert; options = {}; } @@ -59344,15 +63526,15 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroups' + '/compute/beta/projects/{project}/regions/{region}/targetHttpsProxies' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', }, options ), @@ -59362,138 +63544,61 @@ export namespace compute_beta { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.regionInstanceGroups.listInstances - * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // Name of the region scoping this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * // Name of the regional instance group for which we want to list the instances. - * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var itemsPage = response['items']; - * if (!itemsPage) { - * return; - * } - * for (var i = 0; i < itemsPage.length; i++) { - * // TODO: Change code below to process each resource in `itemsPage`: - * console.log(JSON.stringify(itemsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * compute.regionInstanceGroups.listInstances(request, handlePage); - * } - * }; - * - * compute.regionInstanceGroups.listInstances(request, handlePage); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regionInstanceGroups.listInstances + * compute.regionTargetHttpsProxies.list + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. + * @alias compute.regionTargetHttpsProxies.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 {string} params.instanceGroup Name of the regional instance group for which we want to list the instances. * @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 {().RegionInstanceGroupsListInstancesRequest} 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 */ - listInstances( - params?: Params$Resource$Regioninstancegroups$Listinstances, + list( + params?: Params$Resource$Regiontargethttpsproxies$List, options?: MethodOptions - ): GaxiosPromise; - listInstances( - params: Params$Resource$Regioninstancegroups$Listinstances, + ): GaxiosPromise; + list( + params: Params$Resource$Regiontargethttpsproxies$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listInstances( - params: Params$Resource$Regioninstancegroups$Listinstances, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listInstances( - callback: BodyResponseCallback + list( + params: Params$Resource$Regiontargethttpsproxies$List, + callback: BodyResponseCallback ): void; - listInstances( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Regioninstancegroups$Listinstances - | BodyResponseCallback, + | Params$Resource$Regiontargethttpsproxies$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroups$Listinstances; + {}) as Params$Resource$Regiontargethttpsproxies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroups$Listinstances; + params = {} as Params$Resource$Regiontargethttpsproxies$List; options = {}; } @@ -59502,128 +63607,63 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances' + '/compute/beta/projects/{project}/regions/{region}/targetHttpsProxies' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroup'], - pathParams: ['instanceGroup', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * compute.regionInstanceGroups.setNamedPorts - * @desc Sets the named ports for the specified regional instance group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // Name of the region scoping this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * // The name of the regional instance group where the named ports are updated. - * instanceGroup: 'my-instance-group', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * compute.regionInstanceGroups.setNamedPorts(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regionInstanceGroups.setNamedPorts + * compute.regionTargetHttpsProxies.setSslCertificates + * @desc Replaces SslCertificates for TargetHttpsProxy. + * @alias compute.regionTargetHttpsProxies.setSslCertificates * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroup The name of the regional instance group where the named ports are updated. * @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 {().RegionInstanceGroupsSetNamedPortsRequest} params.resource Request body data + * @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 */ - setNamedPorts( - params?: Params$Resource$Regioninstancegroups$Setnamedports, + setSslCertificates( + params?: Params$Resource$Regiontargethttpsproxies$Setsslcertificates, options?: MethodOptions ): GaxiosPromise; - setNamedPorts( - params: Params$Resource$Regioninstancegroups$Setnamedports, + setSslCertificates( + params: Params$Resource$Regiontargethttpsproxies$Setsslcertificates, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setNamedPorts( - params: Params$Resource$Regioninstancegroups$Setnamedports, + setSslCertificates( + params: Params$Resource$Regiontargethttpsproxies$Setsslcertificates, callback: BodyResponseCallback ): void; - setNamedPorts(callback: BodyResponseCallback): void; - setNamedPorts( + setSslCertificates(callback: BodyResponseCallback): void; + setSslCertificates( paramsOrCallback?: - | Params$Resource$Regioninstancegroups$Setnamedports + | Params$Resource$Regiontargethttpsproxies$Setsslcertificates | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -59631,12 +63671,12 @@ export namespace compute_beta { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroups$Setnamedports; + {}) as Params$Resource$Regiontargethttpsproxies$Setsslcertificates; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroups$Setnamedports; + params = {} as Params$Resource$Regiontargethttpsproxies$Setsslcertificates; options = {}; } @@ -59645,21 +63685,21 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts' + '/compute/beta/projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroup'], - pathParams: ['instanceGroup', 'project', 'region'], + requiredParams: ['project', 'region', 'targetHttpsProxy'], + pathParams: ['project', 'region', 'targetHttpsProxy'], context: this.context, }; if (callback) { @@ -59670,114 +63710,51 @@ export namespace compute_beta { } /** - * compute.regionInstanceGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // The name of the region for this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * // Name of the resource for this request. - * resource_: 'my-resource', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * compute.regionInstanceGroups.testIamPermissions(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regionInstanceGroups.testIamPermissions + * 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 The name of the region for this request. - * @param {string} params.resource_ Name or id of the resource for this request. - * @param {().TestPermissionsRequest} params.resource Request body data + * @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 */ - testIamPermissions( - params?: Params$Resource$Regioninstancegroups$Testiampermissions, + setUrlMap( + params?: Params$Resource$Regiontargethttpsproxies$Seturlmap, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Regioninstancegroups$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Regioninstancegroups$Testiampermissions, - callback: BodyResponseCallback + ): GaxiosPromise; + setUrlMap( + params: Params$Resource$Regiontargethttpsproxies$Seturlmap, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + setUrlMap( + params: Params$Resource$Regiontargethttpsproxies$Seturlmap, + callback: BodyResponseCallback ): void; - testIamPermissions( + setUrlMap(callback: BodyResponseCallback): void; + setUrlMap( paramsOrCallback?: - | Params$Resource$Regioninstancegroups$Testiampermissions - | BodyResponseCallback, + | Params$Resource$Regiontargethttpsproxies$Seturlmap + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroups$Testiampermissions; + {}) as Params$Resource$Regiontargethttpsproxies$Seturlmap; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroups$Testiampermissions; + params = {} as Params$Resource$Regiontargethttpsproxies$Seturlmap; options = {}; } @@ -59786,42 +63763,38 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroups/{resource}/testIamPermissions' + '/compute/beta/projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'region', 'targetHttpsProxy'], + pathParams: ['project', 'region', 'targetHttpsProxy'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Regioninstancegroups$Get + export interface Params$Resource$Regiontargethttpsproxies$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - /** - * Name of the instance group resource to return. - */ - instanceGroup?: string; /** * Project ID for this request. */ @@ -59830,8 +63803,16 @@ export namespace compute_beta { * 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 resource to delete. + */ + targetHttpsProxy?: string; } - export interface Params$Resource$Regioninstancegroups$List + export interface Params$Resource$Regiontargethttpsproxies$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -59839,21 +63820,25 @@ 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). + * Project ID for this request. */ - filter?: string; + project?: 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) + * Name of the region scoping this request. */ - maxResults?: number; + region?: 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. + * Name of the TargetHttpsProxy resource to return. */ - orderBy?: string; + targetHttpsProxy?: string; + } + export interface Params$Resource$Regiontargethttpsproxies$Insert + extends StandardParameters { /** - * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * Auth client or API Key for the request */ - pageToken?: string; + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** * Project ID for this request. */ @@ -59862,8 +63847,17 @@ export namespace compute_beta { * 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$TargetHttpsProxy; } - export interface Params$Resource$Regioninstancegroups$Listinstances + export interface Params$Resource$Regiontargethttpsproxies$List extends StandardParameters { /** * Auth client or API Key for the request @@ -59874,10 +63868,6 @@ export namespace compute_beta { * 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; - /** - * Name of the regional instance group for which we want to list the instances. - */ - instanceGroup?: 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) */ @@ -59898,23 +63888,14 @@ export namespace compute_beta { * Name of the region scoping this request. */ region?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RegionInstanceGroupsListInstancesRequest; } - export interface Params$Resource$Regioninstancegroups$Setnamedports + export interface Params$Resource$Regiontargethttpsproxies$Setsslcertificates extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - /** - * The name of the regional instance group where the named ports are updated. - */ - instanceGroup?: string; /** * Project ID for this request. */ @@ -59927,13 +63908,17 @@ export namespace compute_beta { * 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 resource to set an SslCertificates resource for. + */ + targetHttpsProxy?: string; /** * Request body metadata */ - requestBody?: Schema$RegionInstanceGroupsSetNamedPortsRequest; + requestBody?: Schema$RegionTargetHttpsProxiesSetSslCertificatesRequest; } - export interface Params$Resource$Regioninstancegroups$Testiampermissions + export interface Params$Resource$Regiontargethttpsproxies$Seturlmap extends StandardParameters { /** * Auth client or API Key for the request @@ -59945,121 +63930,75 @@ export namespace compute_beta { */ project?: string; /** - * The name of the region for this request. + * Name of the region scoping this request. */ region?: string; /** - * Name or id of the resource for this request. + * 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). */ - resource?: string; + requestId?: string; + /** + * Name of the TargetHttpsProxy to set a URL map for. + */ + targetHttpsProxy?: string; /** * Request body metadata */ - requestBody?: Schema$TestPermissionsRequest; + requestBody?: Schema$UrlMapReference; } - export class Resource$Regionoperations { + export class Resource$Regionurlmaps { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * compute.regionOperations.delete - * @desc Deletes the specified region-specific Operations resource. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // Name of the region for this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * // Name of the Operations resource to delete. - * operation: 'my-operation', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * compute.regionOperations.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regionOperations.delete + * compute.regionUrlMaps.delete + * @desc Deletes the specified UrlMap resource. + * @alias compute.regionUrlMaps.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.operation Name of the Operations resource to delete. * @param {string} params.project Project ID for this request. - * @param {string} params.region Name of the region 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 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$Regionoperations$Delete, + params?: Params$Resource$Regionurlmaps$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Regionoperations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Regionurlmaps$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Regionoperations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Regionurlmaps$Delete, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Regionoperations$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Regionurlmaps$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regionoperations$Delete; + {}) as Params$Resource$Regionurlmaps$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionoperations$Delete; + params = {} as Params$Resource$Regionurlmaps$Delete; options = {}; } @@ -60068,117 +64007,136 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/operations/{operation}' + '/compute/beta/projects/{project}/regions/{region}/urlMaps/{urlMap}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', }, options ), params, - requiredParams: ['project', 'region', 'operation'], - pathParams: ['operation', 'project', 'region'], + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.regionOperations.get - * @desc Retrieves the specified region-specific Operations resource. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // Name of the region for this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * // Name of the Operations resource to return. - * operation: 'my-operation', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * compute.regionOperations.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regionOperations.get + * compute.regionUrlMaps.get + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. + * @alias compute.regionUrlMaps.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.operation Name of the Operations resource to return. * @param {string} params.project Project ID for this request. - * @param {string} params.region Name of the region for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string} params.urlMap Name of the UrlMap 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$Regionoperations$Get, + params?: Params$Resource$Regionurlmaps$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Regionoperations$Get, + params: Params$Resource$Regionurlmaps$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionurlmaps$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/urlMaps/{urlMap}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionUrlMaps.insert + * @desc Creates a UrlMap resource in the specified project using the data included in the request. + * @alias compute.regionUrlMaps.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 begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + * @param {().UrlMap} 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$Regionurlmaps$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionurlmaps$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regionoperations$Get, + insert( + params: Params$Resource$Regionurlmaps$Insert, callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + insert(callback: BodyResponseCallback): void; + insert( paramsOrCallback?: - | Params$Resource$Regionoperations$Get + | Params$Resource$Regionurlmaps$Insert | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -60186,12 +64144,12 @@ export namespace compute_beta { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regionoperations$Get; + {}) as Params$Resource$Regionurlmaps$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionoperations$Get; + params = {} as Params$Resource$Regionurlmaps$Insert; options = {}; } @@ -60200,21 +64158,21 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/operations/{operation}' + '/compute/beta/projects/{project}/regions/{region}/urlMaps' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['project', 'region', 'operation'], - pathParams: ['operation', 'project', 'region'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.context, }; if (callback) { @@ -60225,75 +64183,87 @@ export namespace compute_beta { } /** - * compute.regionOperations.list - * @desc Retrieves a list of Operation resources contained within the specified region. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // Name of the region for this request. - * region: 'my-region', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var itemsPage = response['items']; - * if (!itemsPage) { - * return; - * } - * for (var i = 0; i < itemsPage.length; i++) { - * // TODO: Change code below to process each resource in `itemsPage`: - * console.log(JSON.stringify(itemsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * compute.regionOperations.list(request, handlePage); - * } - * }; - * - * compute.regionOperations.list(request, handlePage); - * }); + * compute.regionUrlMaps.invalidateCache + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. + * @alias compute.regionUrlMaps.invalidateCache + * @memberOf! () * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regionOperations.list + * @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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/urlMaps/{urlMap}/invalidateCache' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionUrlMaps.list + * @desc Retrieves the list of UrlMap resources available to the specified project in the specified region. + * @alias compute.regionUrlMaps.list * @memberOf! () * * @param {object} params Parameters for request @@ -60302,41 +64272,119 @@ export namespace compute_beta { * @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.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$Regionoperations$List, + params?: Params$Resource$Regionurlmaps$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionurlmaps$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionurlmaps$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionurlmaps$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/urlMaps' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionUrlMaps.patch + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * @alias compute.regionUrlMaps.patch + * @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 resource to patch. + * @param {().UrlMap} 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$Regionurlmaps$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Regionoperations$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + patch( + params: Params$Resource$Regionurlmaps$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regionoperations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Regionurlmaps$Patch, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Regionoperations$List - | BodyResponseCallback, + | Params$Resource$Regionurlmaps$Patch + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regionoperations$List; + {}) as Params$Resource$Regionurlmaps$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regionoperations$List; + params = {} as Params$Resource$Regionurlmaps$Patch; options = {}; } @@ -60345,203 +64393,76 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/operations' + '/compute/beta/projects/{project}/regions/{region}/urlMaps/{urlMap}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Regionoperations$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the Operations resource to delete. - */ - operation?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - } - export interface Params$Resource$Regionoperations$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the Operations resource to return. - */ - operation?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - } - export interface Params$Resource$Regionoperations$List - extends StandardParameters { - /** - * 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 class Resource$Regions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * compute.regions.get - * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // Name of the region resource to return. - * region: 'my-region', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * compute.regions.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regions.get + * compute.regionUrlMaps.update + * @desc Updates the specified UrlMap resource with the data included in the request. + * @alias compute.regionUrlMaps.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.region Name of the region resource to return. + * @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 resource to update. + * @param {().UrlMap} 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 */ - get( - params?: Params$Resource$Regions$Get, + update( + params?: Params$Resource$Regionurlmaps$Update, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Regions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + update( + params: Params$Resource$Regionurlmaps$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Regions$Get, - callback: BodyResponseCallback + update( + params: Params$Resource$Regionurlmaps$Update, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Regions$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Regions$Get; + | Params$Resource$Regionurlmaps$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regions$Get; + params = {} as Params$Resource$Regionurlmaps$Update; options = {}; } @@ -60550,137 +64471,79 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { url: ( - rootUrl + '/compute/beta/projects/{project}/regions/{region}' + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/urlMaps/{urlMap}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PUT', }, options ), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.regions.list - * @desc Retrieves the list of region resources available to the specified project. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('beta'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var itemsPage = response['items']; - * if (!itemsPage) { - * return; - * } - * for (var i = 0; i < itemsPage.length; i++) { - * // TODO: Change code below to process each resource in `itemsPage`: - * console.log(JSON.stringify(itemsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * compute.regions.list(request, handlePage); - * } - * }; - * - * compute.regions.list(request, handlePage); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.regions.list + * compute.regionUrlMaps.validate + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. + * @alias compute.regionUrlMaps.validate * @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 {string} params.urlMap Name of the UrlMap resource to be validated as. + * @param {().RegionUrlMapsValidateRequest} 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 */ - list( - params?: Params$Resource$Regions$List, + validate( + params?: Params$Resource$Regionurlmaps$Validate, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Regions$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + validate( + params: Params$Resource$Regionurlmaps$Validate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Regions$List, - callback: BodyResponseCallback + validate( + params: Params$Resource$Regionurlmaps$Validate, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + validate( + callback: BodyResponseCallback + ): void; + validate( paramsOrCallback?: - | Params$Resource$Regions$List - | BodyResponseCallback, + | Params$Resource$Regionurlmaps$Validate + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Regions$List; + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionurlmaps$Validate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regions$List; + params = {} as Params$Resource$Regionurlmaps$Validate; options = {}; } @@ -60689,32 +64552,33 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/compute/beta/projects/{project}/regions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/urlMaps/{urlMap}/validate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Regions$Get extends StandardParameters { + export interface Params$Resource$Regionurlmaps$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -60725,11 +64589,94 @@ export namespace compute_beta { */ project?: string; /** - * Name of the region resource to return. + * Name of the region scoping this request. */ region?: string; + /** + * begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + */ + requestId?: string; + /** + * Name of the UrlMap resource to delete. + */ + urlMap?: string; } - export interface Params$Resource$Regions$List extends StandardParameters { + export interface Params$Resource$Regionurlmaps$Get + extends StandardParameters { + /** + * 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 UrlMap resource to return. + */ + urlMap?: string; + } + export interface Params$Resource$Regionurlmaps$Insert + extends StandardParameters { + /** + * 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; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMap; + } + export interface Params$Resource$Regionurlmaps$Invalidatecache + extends StandardParameters { + /** + * 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 + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -60755,6 +64702,93 @@ export namespace compute_beta { * Project ID for this request. */ project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionurlmaps$Patch + extends StandardParameters { + /** + * 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 resource to patch. + */ + urlMap?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMap; + } + export interface Params$Resource$Regionurlmaps$Update + extends StandardParameters { + /** + * 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 resource to update. + */ + urlMap?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMap; + } + export interface Params$Resource$Regionurlmaps$Validate + extends StandardParameters { + /** + * 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 UrlMap resource to be validated as. + */ + urlMap?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionUrlMapsValidateRequest; } export class Resource$Reservations { @@ -60821,7 +64855,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -60901,7 +64935,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -60976,7 +65010,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61050,7 +65084,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61076,7 +65110,7 @@ export namespace compute_beta { /** * compute.reservations.insert - * @desc Creates a new reservation. + * @desc Creates a new reservation. For more information, read Reserving zonal resources. * @alias compute.reservations.insert * @memberOf! () * @@ -61127,7 +65161,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61206,7 +65240,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61284,7 +65318,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61359,7 +65393,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61440,7 +65474,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61757,7 +65791,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61839,7 +65873,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61915,7 +65949,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -61939,6 +65973,80 @@ export namespace compute_beta { } } + /** + * compute.resourcePolicies.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.resourcePolicies.getIamPolicy + * @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 or id 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$Resourcepolicies$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Resourcepolicies$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Resourcepolicies$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Resourcepolicies$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Resourcepolicies$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.resourcePolicies.insert * @desc Creates a new resource policy. @@ -61992,7 +66100,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62071,7 +66179,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62095,6 +66203,81 @@ export namespace compute_beta { } } + /** + * compute.resourcePolicies.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.resourcePolicies.setIamPolicy + * @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 or id of the resource for this request. + * @param {().RegionSetPolicyRequest} 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$Resourcepolicies$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Resourcepolicies$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Resourcepolicies$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Resourcepolicies$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Resourcepolicies$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.resourcePolicies.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. @@ -62152,7 +66335,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62249,6 +66432,26 @@ export namespace compute_beta { */ resourcePolicy?: string; } + export interface Params$Resource$Resourcepolicies$Getiampolicy + extends StandardParameters { + /** + * 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 or id of the resource for this request. + */ + resource?: string; + } export interface Params$Resource$Resourcepolicies$Insert extends StandardParameters { /** @@ -62306,6 +66509,31 @@ export namespace compute_beta { */ region?: string; } + export interface Params$Resource$Resourcepolicies$Setiampolicy + extends StandardParameters { + /** + * 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 or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } export interface Params$Resource$Resourcepolicies$Testiampermissions extends StandardParameters { /** @@ -62459,7 +66687,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62590,7 +66818,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62719,7 +66947,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62803,7 +67031,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -62942,7 +67170,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -63075,7 +67303,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -63219,7 +67447,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -63357,7 +67585,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -63497,7 +67725,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -63638,7 +67866,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -63664,7 +67892,7 @@ export namespace compute_beta { /** * compute.routers.update - * @desc Updates the specified Router resource with the data included in the request. + * @desc Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. * @example * * // BEFORE RUNNING: * // --------------- @@ -63776,7 +68004,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64198,7 +68426,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64322,7 +68550,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64450,7 +68678,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64589,7 +68817,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64725,7 +68953,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -64912,7 +69140,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65041,7 +69269,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65169,7 +69397,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65245,7 +69473,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65376,7 +69604,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65517,7 +69745,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65617,7 +69845,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65756,7 +69984,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65834,7 +70062,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65910,7 +70138,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -65986,7 +70214,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66123,7 +70351,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66537,7 +70765,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66662,7 +70890,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66735,7 +70963,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66875,7 +71103,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -66948,7 +71176,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67081,7 +71309,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67218,7 +71446,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67390,6 +71618,93 @@ export namespace compute_beta { this.context = context; } + /** + * 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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/aggregated/sslCertificates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * compute.sslCertificates.delete * @desc Deletes the specified SslCertificate resource. @@ -67495,7 +71810,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67623,7 +71938,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67753,7 +72068,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -67894,7 +72209,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -68031,7 +72346,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -68056,6 +72371,34 @@ export namespace compute_beta { } } + export interface Params$Resource$Sslcertificates$Aggregatedlist + extends StandardParameters { + /** + * 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 extends StandardParameters { /** @@ -68221,7 +72564,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -68295,7 +72638,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -68371,7 +72714,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -68447,7 +72790,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -68536,7 +72879,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -68618,7 +72961,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -68698,7 +73041,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69008,7 +73351,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69141,7 +73484,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69279,7 +73622,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69410,7 +73753,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69540,7 +73883,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69674,7 +74017,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69818,7 +74161,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69900,7 +74243,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -69997,6 +74340,7 @@ export namespace compute_beta { * @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). @@ -70044,7 +74388,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -70179,7 +74523,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -70319,7 +74663,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -70460,7 +74804,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -70696,6 +75040,10 @@ export namespace compute_beta { */ 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. */ @@ -70804,6 +75152,93 @@ export namespace compute_beta { this.context = context; } + /** + * compute.targetHttpProxies.aggregatedList + * @desc Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. + * @alias compute.targetHttpProxies.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$Targethttpproxies$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Targethttpproxies$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Targethttpproxies$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Targethttpproxies$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targethttpproxies$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpproxies$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/aggregated/targetHttpProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * compute.targetHttpProxies.delete * @desc Deletes the specified TargetHttpProxy resource. @@ -70909,7 +75344,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71037,7 +75472,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71167,7 +75602,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71308,7 +75743,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71442,7 +75877,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71579,7 +76014,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71604,6 +76039,34 @@ export namespace compute_beta { } } + export interface Params$Resource$Targethttpproxies$Aggregatedlist + extends StandardParameters { + /** + * 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$Targethttpproxies$Delete extends StandardParameters { /** @@ -71742,6 +76205,93 @@ export namespace compute_beta { this.context = context; } + /** + * 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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/aggregated/targetHttpsProxies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * compute.targetHttpsProxies.delete * @desc Deletes the specified TargetHttpsProxy resource. @@ -71847,7 +76397,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -71975,7 +76525,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72105,7 +76655,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72248,7 +76798,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72325,7 +76875,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72459,7 +77009,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72536,7 +77086,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72670,7 +77220,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72807,7 +77357,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -72832,6 +77382,34 @@ export namespace compute_beta { } } + export interface Params$Resource$Targethttpsproxies$Aggregatedlist + extends StandardParameters { + /** + * 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 extends StandardParameters { /** @@ -73166,7 +77744,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -73304,7 +77882,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -73436,7 +78014,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -73570,7 +78148,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -73715,7 +78293,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -73856,7 +78434,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74156,7 +78734,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74294,7 +78872,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74439,7 +79017,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74572,7 +79150,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74703,7 +79281,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74844,7 +79422,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -74978,7 +79556,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -75122,7 +79700,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -75260,7 +79838,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -75398,7 +79976,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -75537,7 +80115,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -75678,7 +80256,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -76141,7 +80719,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -76269,7 +80847,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -76399,7 +80977,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -76540,7 +81118,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -76674,7 +81252,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -76808,7 +81386,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -76942,7 +81520,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -77019,7 +81597,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -77156,7 +81734,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -77499,7 +82077,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -77627,7 +82205,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -77757,7 +82335,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -77898,7 +82476,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -78032,7 +82610,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -78166,7 +82744,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -78454,7 +83032,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -78592,7 +83170,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -78724,7 +83302,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -78858,7 +83436,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -79005,7 +83583,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -79083,7 +83661,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -79224,7 +83802,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -79439,6 +84017,87 @@ export namespace compute_beta { this.context = context; } + /** + * 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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/beta/projects/{project}/aggregated/urlMaps' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.urlMaps.delete * @desc Deletes the specified UrlMap resource. @@ -79543,7 +84202,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -79668,7 +84327,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -79797,7 +84456,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -79930,7 +84589,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -80070,7 +84729,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -80203,7 +84862,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -80340,7 +84999,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -80474,7 +85133,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -80610,7 +85269,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -80635,6 +85294,34 @@ export namespace compute_beta { } } + export interface Params$Resource$Urlmaps$Aggregatedlist + extends StandardParameters { + /** + * 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 extends StandardParameters { /** * Auth client or API Key for the request @@ -80895,7 +85582,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -80972,7 +85659,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -81047,7 +85734,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -81127,7 +85814,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -81209,7 +85896,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -81287,7 +85974,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -81365,7 +86052,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -81694,7 +86381,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -81826,7 +86513,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -81957,7 +86644,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -82091,7 +86778,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -82235,7 +86922,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -82313,7 +87000,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -82454,7 +87141,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -82770,7 +87457,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -82902,7 +87589,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -83047,7 +87734,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -83252,7 +87939,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { @@ -83389,7 +88076,7 @@ export namespace compute_beta { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; const parameters = { options: Object.assign( { diff --git a/src/apis/compute/package.json b/src/apis/compute/package.json index c2c7b0c9c50..3c3b0efc84e 100644 --- a/src/apis/compute/package.json +++ b/src/apis/compute/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index 0302f8757a0..f27789e84df 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -130,6 +130,8 @@ export namespace compute_v1 { regionInstanceGroups: Resource$Regioninstancegroups; regionOperations: Resource$Regionoperations; regions: Resource$Regions; + reservations: Resource$Reservations; + resourcePolicies: Resource$Resourcepolicies; routers: Resource$Routers; routes: Resource$Routes; securityPolicies: Resource$Securitypolicies; @@ -212,6 +214,8 @@ export namespace compute_v1 { ); this.regionOperations = new Resource$Regionoperations(this.context); this.regions = new Resource$Regions(this.context); + this.reservations = new Resource$Reservations(this.context); + this.resourcePolicies = new Resource$Resourcepolicies(this.context); this.routers = new Resource$Routers(this.context); this.routes = new Resource$Routes(this.context); this.securityPolicies = new Resource$Securitypolicies(this.context); @@ -247,7 +251,7 @@ export namespace compute_v1 { acceleratorType?: string; } /** - * An Accelerator Type resource. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==) + * Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==) */ export interface Schema$AcceleratorType { /** @@ -373,7 +377,7 @@ export namespace compute_v1 { */ kind?: string; /** - * The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. + * The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. */ name?: string; /** @@ -385,11 +389,11 @@ export namespace compute_v1 { */ 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. + * The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled. */ publicPtrDomainName?: string; /** - * Specifies whether a public DNS ?PTR? record should be created to map the external IP address of the instance to a DNS domain name. + * Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. */ setPublicPtr?: boolean; /** @@ -398,7 +402,7 @@ export namespace compute_v1 { type?: string; } /** - * A reserved address resource. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==) + * Represents an IP Address resource. An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses. A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==) */ export interface Schema$Address { /** @@ -414,7 +418,7 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you create the resource. + * An optional description of this resource. Provide this field when you create the resource. */ description?: string; /** @@ -422,7 +426,7 @@ export namespace compute_v1 { */ id?: string; /** - * The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. + * The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. */ ipVersion?: string; /** @@ -430,15 +434,15 @@ export namespace compute_v1 { */ 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 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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. */ name?: string; /** - * The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with VPC_PEERING purpose. + * The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose. */ network?: string; /** - * This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM, STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a Network load balancer. If this field is not specified, it is assumed to be PREMIUM. + * This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer. If this field is not specified, it is assumed to be PREMIUM. */ networkTier?: string; /** @@ -446,11 +450,11 @@ export namespace compute_v1 { */ prefixLength?: number; /** - * The purpose of resource, only used with INTERNAL type. + * The purpose of this resource, which can be one of the following values: - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. - `DNS_RESOLVER` for a DNS resolver address in a subnetwork - `VPC_PEERING` for addresses that are reserved for VPC peer networks. - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT. */ purpose?: 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 as part of the HTTP request URL. You cannot set this field in the request body. + * [Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL. */ region?: string; /** @@ -462,7 +466,7 @@ export namespace compute_v1 { */ status?: string; /** - * The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. + * The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose. */ subnetwork?: string; /** @@ -552,14 +556,62 @@ export namespace compute_v1 { */ export interface Schema$AliasIpRange { /** - * The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24). + * The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24). */ ipCidrRange?: string; /** - * Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. + * The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. */ subnetworkRangeName?: string; } + export interface Schema$AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk { + /** + * Specifies the size of the disk in base-2 GB. + */ + diskSizeGb?: string; + /** + * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. + */ + interface?: string; + } + /** + * Properties of the SKU instances being reserved. + */ + export interface Schema$AllocationSpecificSKUAllocationReservedInstanceProperties { + /** + * Specifies accelerator type and count. + */ + guestAccelerators?: Schema$AcceleratorConfig[]; + /** + * Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd. + */ + localSsds?: Schema$AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk[]; + /** + * Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern. + */ + machineType?: string; + /** + * Minimum cpu platform the reservation. + */ + minCpuPlatform?: string; + } + /** + * This reservation type allows to pre allocate specific instance configuration. + */ + export interface Schema$AllocationSpecificSKUReservation { + /** + * Specifies number of resources that are allocated. + */ + count?: string; + /** + * The instance properties for this specific sku reservation. + */ + instanceProperties?: Schema$AllocationSpecificSKUAllocationReservedInstanceProperties; + /** + * [OutputOnly] Indicates how many resource are in use. + */ + inUseCount?: string; + } /** * An instance-attached disk resource. */ @@ -593,7 +645,7 @@ export namespace compute_v1 { */ initializeParams?: Schema$AttachedDiskInitializeParams; /** - * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. + * Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. TODO(b/131765817): Update documentation when NVME is supported. */ interface?: string; /** @@ -641,6 +693,10 @@ export namespace compute_v1 { * Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. */ labels?: {[key: string]: string}; + /** + * Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. + */ + resourcePolicies?: string[]; /** * The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. */ @@ -649,6 +705,14 @@ export namespace compute_v1 { * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys. */ sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, 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 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. @@ -687,7 +751,7 @@ export namespace compute_v1 { permissionType?: string; } /** - * Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==) + * Represents an Autoscaler resource. Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==) */ export interface Schema$Autoscaler { /** @@ -895,7 +959,7 @@ export namespace compute_v1 { */ export interface Schema$Backend { /** - * Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). For Internal Load Balancing, the default and only supported mode is CONNECTION. + * Specifies the balancing mode for the backend. When choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG). - If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle. The CONNECTION balancing mode is only available if the protocol for the backend service is SSL, TCP, or UDP. If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters. - If the load balancing mode is RATE, then the load is spread based on the rate of HTTP requests per second (RPS). The RATE balancing mode is only available if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate, maxRatePerInstance, or maxRatePerEndpoint. - If the load balancing mode is UTILIZATION, then the load is spread based on the CPU utilization of instances in an instance group. The UTILIZATION balancing mode is only available if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backend is made up of instance groups. There are no restrictions on the backend service protocol. */ balancingMode?: string; /** @@ -907,19 +971,19 @@ export namespace compute_v1 { */ description?: string; /** - * The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group. Backend service can not contain mix of Instance Group and Network Endpoint Group backends. Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL. When the BackendService has load balancing scheme INTERNAL, the instance group must be within the same region as the BackendService. Network Endpoint Groups are not supported for INTERNAL load balancing scheme. + * The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme. - When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. - When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. */ group?: string; /** - * The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing. + * Defines a maximum target for simultaneous connections for the entire backend (instance group or NEG). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION. */ maxConnections?: number; /** - * The max number of simultaneous connections that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set. This cannot be used for internal load balancing. + * Defines a maximum target for simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION. */ maxConnectionsPerEndpoint?: number; /** - * The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing. + * Defines a maximum target for simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint. Not available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION. */ maxConnectionsPerInstance?: number; /** @@ -927,20 +991,20 @@ export namespace compute_v1 { */ maxRate?: number; /** - * The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set. This cannot be used for internal load balancing. + * Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerInstance. Not available if the backend's balancingMode is CONNECTION. */ maxRatePerEndpoint?: number; /** - * The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing. + * Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate, or maxRatePerEndpoint. Not available if the backend's balancingMode is CONNECTION. */ maxRatePerInstance?: number; /** - * Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0]. This cannot be used for internal load balancing. + * Defines the maximum average CPU utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION. This parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections, or maxConnectionsPerInstance. */ maxUtilization?: number; } /** - * A BackendBucket resource. This resource defines a Cloud Storage bucket. + * Represents a Cloud Storage Bucket resource. This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets. */ export interface Schema$BackendBucket { /** @@ -1027,11 +1091,11 @@ export namespace compute_v1 { }; } /** - * A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) + * Represents a Backend Service resource. Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services. A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director. A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) */ export interface Schema$BackendService { /** - * Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used. + * If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is one day (86,400). */ affinityCookieTtlSec?: number; /** @@ -1056,7 +1120,7 @@ export namespace compute_v1 { */ description?: string; /** - * If true, enable Cloud CDN for this BackendService. When the load balancing scheme is INTERNAL, this field is not used. + * If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS. */ enableCDN?: boolean; /** @@ -1085,15 +1149,15 @@ export namespace compute_v1 { */ name?: string; /** - * Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. This cannot be used for internal load balancing. + * Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing). */ port?: number; /** - * Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. When the load balancing scheme is INTERNAL, this field is not used. + * A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Blaancing). */ portName?: string; /** - * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. For internal load balancing, the possible values are TCP and UDP, and the default is TCP. + * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic director for more information. */ protocol?: string; /** @@ -1109,11 +1173,11 @@ export namespace compute_v1 { */ selfLink?: string; /** - * Type of session affinity to use. The default is NONE. When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the protocol is UDP, this field is not used. + * Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP. When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. GENERATED_COOKIE is only available if the protocol is HTTP or HTTPS. When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the loadBalancingScheme is INTERNAL_SELF_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE. */ sessionAffinity?: string; /** - * How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. + * The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds. */ timeoutSec?: number; } @@ -1289,7 +1353,7 @@ export namespace compute_v1 { queryStringWhitelist?: string[]; } /** - * Represents a Commitment resource. Creating a Commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. Committed use discounts are subject to Google Cloud Platform's Service Specific Terms. By purchasing a committed use discount, you agree to these terms. Committed use discounts will not renew, so you must purchase a new commitment to continue receiving discounts. (== resource_for beta.commitments ==) (== resource_for v1.commitments ==) + * Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==) */ export interface Schema$Commitment { /** @@ -1324,6 +1388,10 @@ export namespace compute_v1 { * [Output Only] URL of the region where this commitment may be used. */ region?: string; + /** + * List of reservations for this commitment. + */ + reservations?: Schema$Reservation[]; /** * A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. */ @@ -1452,7 +1520,7 @@ export namespace compute_v1 { */ export interface Schema$ConnectionDraining { /** - * Time for which instance will be drained (not accept new connections, but still work to finish started). + * The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600]. */ drainingTimeoutSec?: number; } @@ -1509,7 +1577,7 @@ export namespace compute_v1 { state?: string; } /** - * A Disk resource. (== resource_for beta.disks ==) (== resource_for v1.disks ==) + * Represents a Persistent Disk resource. Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for beta.disks ==) (== resource_for v1.disks ==) (== resource_for v1.regionDisks ==) (== resource_for beta.regionDisks ==) */ export interface Schema$Disk { /** @@ -1521,7 +1589,7 @@ export namespace compute_v1 { */ description?: string; /** - * Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. + * Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; /** @@ -1580,6 +1648,10 @@ export namespace compute_v1 { * URLs of the zones where the disk should be replicated to. Only applicable 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. */ @@ -1617,11 +1689,11 @@ export namespace compute_v1 { */ status?: string; /** - * URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: project/zones/zone/diskTypes/pd-standard or pd-ssd + * URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd */ type?: string; /** - * [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance + * [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance */ users?: string[]; /** @@ -1723,6 +1795,18 @@ export namespace compute_v1 { */ 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. @@ -1744,7 +1828,7 @@ export namespace compute_v1 { }; } /** - * A DiskType resource. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==) + * Represents a Disk Type resource. You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==) (== resource_for v1.regionDiskTypes ==) (== resource_for beta.regionDiskTypes ==) */ export interface Schema$DiskType { /** @@ -1903,7 +1987,7 @@ export namespace compute_v1 { title?: string; } /** - * Represents a Firewall resource. + * Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules. */ export interface Schema$Firewall { /** @@ -1919,19 +2003,19 @@ export namespace compute_v1 { */ denied?: Array<{IPProtocol?: string; ports?: string[]}>; /** - * An optional description of this resource. Provide this property when you create the resource. + * An optional description of this resource. Provide this field when you create the resource. */ description?: string; /** - * If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. + * If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. */ destinationRanges?: string[]; /** - * Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags. + * Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields. */ direction?: string; /** - * Denotes whether the firewall rule is disabled, i.e not applied to the network it is associated with. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. + * Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. */ disabled?: boolean; /** @@ -1947,15 +2031,15 @@ export namespace compute_v1 { */ logConfig?: Schema$FirewallLogConfig; /** - * 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 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. */ name?: string; /** - * URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default + * URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default */ network?: string; /** - * Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority. + * Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`. */ priority?: number; /** @@ -1963,15 +2047,15 @@ export namespace compute_v1 { */ selfLink?: string; /** - * If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported. + * If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported. */ sourceRanges?: string[]; /** - * If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. + * If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. */ sourceServiceAccounts?: string[]; /** - * If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. + * If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply. */ sourceTags?: string[]; /** @@ -2043,7 +2127,7 @@ export namespace compute_v1 { percent?: number; } /** - * A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, ports] tuple. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) + * Represents a Forwarding Rule resource. A forwardingRules resource represents a regional forwarding rule. Regional external forwarding rules can reference any of the following resources: - A target instance - A Cloud VPN Classic gateway (targetVpnGateway), - A target pool for a Network Load Balancer - A global target HTTP(S) proxy for an HTTP(S) load balancer using Standard Tier - A target SSL proxy for a SSL Proxy load balancer using Standard Tier - A target TCP proxy for a TCP Proxy load balancer using Standard Tier. Regional internal forwarding rules can reference the backend service of an internal TCP/UDP load balancer. For regional internal forwarding rules, the following applies: - If the loadBalancingScheme for the load balancer is INTERNAL, then the forwarding rule references a regional internal backend service. - If the loadBalancingScheme for the load balancer is INTERNAL_MANAGED, then the forwarding rule must reference a regional target HTTP(S) proxy. For more information, read Using Forwarding rules. A globalForwardingRules resource represents a global forwarding rule. Global forwarding rules are only used by load balancers that use Premium Tier. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) */ export interface Schema$ForwardingRule { /** @@ -2235,6 +2319,58 @@ export namespace compute_v1 { */ policy?: Schema$Policy; } + /** + * A guest attributes entry. + */ + export interface Schema$GuestAttributes { + /** + * [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry. + */ + kind?: string; + /** + * The path to be queried. This can be the default namespace ('/') or a nested namespace ('//') or a specified key ('//') + */ + queryPath?: string; + /** + * [Output Only] The value of the requested queried path. + */ + queryValue?: Schema$GuestAttributesValue; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * The key to search for. + */ + variableKey?: string; + /** + * [Output Only] The value found for the requested key. + */ + variableValue?: string; + } + /** + * A guest attributes namespace/key/value entry. + */ + export interface Schema$GuestAttributesEntry { + /** + * Key for the guest attribute entry. + */ + key?: string; + /** + * Namespace for the guest attribute entry. + */ + namespace?: string; + /** + * Value for the guest attribute entry. + */ + value?: string; + } + /** + * Array of guest attribute namespace/key/value tuples. + */ + export interface Schema$GuestAttributesValue { + items?: Schema$GuestAttributesEntry[]; + } /** * Guest OS features. */ @@ -2245,7 +2381,7 @@ export namespace compute_v1 { type?: string; } /** - * An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols. + * Represents a Health Check resource. Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts. To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks. */ export interface Schema$HealthCheck { /** @@ -2451,7 +2587,7 @@ export namespace compute_v1 { response?: string; } /** - * An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP. + * Represents a legacy HTTP Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. */ export interface Schema$HttpHealthCheck { /** @@ -2491,7 +2627,7 @@ export namespace compute_v1 { */ port?: number; /** - * The request path of the HTTP health check request. The default value is /. + * The request path of the HTTP health check request. The default value is /. This field does not support query parameters. */ requestPath?: string; /** @@ -2571,7 +2707,7 @@ export namespace compute_v1 { response?: string; } /** - * An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS. + * Represents a legacy HTTPS Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. */ export interface Schema$HttpsHealthCheck { /** @@ -2661,7 +2797,7 @@ export namespace compute_v1 { }; } /** - * An Image resource. (== resource_for beta.images ==) (== resource_for v1.images ==) + * Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for beta.images ==) (== resource_for v1.images ==) */ export interface Schema$Image { /** @@ -2811,7 +2947,7 @@ export namespace compute_v1 { }; } /** - * An Instance resource. (== resource_for beta.instances ==) (== resource_for v1.instances ==) + * Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for beta.instances ==) (== resource_for v1.instances ==) */ export interface Schema$Instance { /** @@ -2879,6 +3015,10 @@ export namespace compute_v1 { * An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. */ networkInterfaces?: Schema$NetworkInterface[]; + /** + * Specifies the reservations that this instance can consume from. + */ + reservationAffinity?: Schema$ReservationAffinity; /** * Sets the scheduling options for this instance. */ @@ -2920,7 +3060,7 @@ export namespace compute_v1 { */ id?: string; /** - * A list of InstancesScopedList resources. + * An object that contains a list of instances scoped by zone. */ items?: {[key: string]: Schema$InstancesScopedList}; /** @@ -2945,7 +3085,7 @@ export namespace compute_v1 { }; } /** - * InstanceGroups (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) + * Represents an unmanaged Instance Group resource. Use unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. For more information, read Instance groups. For zonal unmanaged Instance Group, use instanceGroups resource. For regional unmanaged Instance Group, use regionInstanceGroups resource. (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) */ export interface Schema$InstanceGroup { /** @@ -3065,7 +3205,7 @@ export namespace compute_v1 { }; } /** - * An Instance Group Manager resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) + * Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) */ export interface Schema$InstanceGroupManager { /** @@ -3337,6 +3477,9 @@ export namespace compute_v1 { * Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action. */ minimalAction?: string; + /** + * The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls). + */ type?: string; } export interface Schema$InstanceGroupManagerVersion { @@ -3538,6 +3681,10 @@ export namespace compute_v1 { * An array of network access configurations for this interface. */ networkInterfaces?: Schema$NetworkInterface[]; + /** + * Specifies the reservations that this instance can consume from. + */ + reservationAffinity?: Schema$ReservationAffinity; /** * Specifies the scheduling options for the instances that are created from this template. */ @@ -3614,7 +3761,7 @@ export namespace compute_v1 { disks?: Schema$CustomerEncryptionKeyProtectedDisk[]; } /** - * An Instance Template resource. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==) + * Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==) */ export interface Schema$InstanceTemplate { /** @@ -3702,7 +3849,7 @@ export namespace compute_v1 { status?: string; } /** - * Represents an Interconnects resource. The Interconnects resource is a dedicated connection between Google's network and your on-premises network. For more information, see the Dedicated overview page. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) + * Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) */ export interface Schema$Interconnect { /** @@ -3746,7 +3893,7 @@ export namespace compute_v1 { */ interconnectAttachments?: string[]; /** - * Type of interconnect. Note that "IT_PRIVATE" has been deprecated in favor of "DEDICATED" + * Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. */ interconnectType?: string; /** @@ -3754,7 +3901,7 @@ export namespace compute_v1 { */ kind?: string; /** - * Type of link requested. This field indicates speed of each of the links in the bundle, not the entire bundle. + * Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. */ linkType?: string; /** @@ -3770,7 +3917,7 @@ export namespace compute_v1 { */ nocContactEmail?: string; /** - * [Output Only] The current status of whether or not this Interconnect is functional. + * [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. */ operationalStatus?: string; /** @@ -3790,12 +3937,12 @@ export namespace compute_v1 { */ selfLink?: string; /** - * [Output Only] The current state of whether or not this Interconnect is functional. + * [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. */ state?: string; } /** - * Represents an InterconnectAttachment (VLAN attachment) resource. For more information, see Creating VLAN Attachments. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==) + * Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==) */ export interface Schema$InterconnectAttachment { /** @@ -3803,7 +3950,7 @@ export namespace compute_v1 { */ adminEnabled?: boolean; /** - * Provisioned bandwidth capacity for the interconnectAttachment. Can be set by the partner to update the customer's provisioned bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED. + * Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s */ bandwidth?: string; /** @@ -3827,11 +3974,11 @@ export namespace compute_v1 { */ description?: string; /** - * Desired availability domain for the attachment. Only available for type PARTNER, at creation time. For improved reliability, customers should configure a pair of attachments with one per availability domain. The selected availability domain will be provided to the Partner via the pairing key so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. + * Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. */ edgeAvailabilityDomain?: string; /** - * [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. + * [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used. */ googleReferenceId?: string; /** @@ -3851,7 +3998,7 @@ export namespace compute_v1 { */ name?: string; /** - * [Output Only] The current status of whether or not this interconnect attachment is functional. + * [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. */ operationalStatus?: string; /** @@ -3859,7 +4006,7 @@ export namespace compute_v1 { */ pairingKey?: string; /** - * Optional BGP ASN for the router that should be supplied by a layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. + * Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. */ partnerAsn?: string; /** @@ -3883,9 +4030,12 @@ export namespace compute_v1 { */ selfLink?: string; /** - * [Output Only] The current state of this attachment's functionality. + * [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. */ state?: string; + /** + * The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. + */ type?: string; /** * The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time. @@ -3968,7 +4118,7 @@ export namespace compute_v1 { */ partnerName?: string; /** - * URL of the Partner?s portal for this Attachment. Partners may customise this to be a deep-link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. + * URL of the Partner?s portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. */ portalUrl?: string; } @@ -4051,6 +4201,9 @@ export namespace compute_v1 { * System ID of the port on the neighbor?s side of the LACP exchange. */ neighborSystemId?: string; + /** + * The state of a LACP link, which can take one of the following values: - ACTIVE: The link is configured and active within the bundle. - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty. + */ state?: string; } export interface Schema$InterconnectDiagnosticsLinkOpticalPower { @@ -4120,7 +4273,7 @@ export namespace compute_v1 { }; } /** - * Represents an InterconnectLocations resource. The InterconnectLocations resource describes the locations where you can connect to Google's networks. For more information, see Colocation Facilities. + * Represents an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments. */ export interface Schema$InterconnectLocation { /** @@ -4136,7 +4289,7 @@ export namespace compute_v1 { */ city?: string; /** - * [Output Only] Continent for this location. + * [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA */ continent?: string; /** @@ -4180,7 +4333,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * [Output Only] The status of this InterconnectLocation. If the status is AVAILABLE, new Interconnects may be provisioned in this InterconnectLocation. Otherwise, no new Interconnects may be provisioned. + * [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. */ status?: string; } @@ -4251,7 +4404,7 @@ export namespace compute_v1 { */ endTime?: string; /** - * Form this outage is expected to take. Note that the "IT_" versions of this enum have been deprecated in favor of the unprefixed values. + * Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. */ issueType?: string; /** @@ -4259,7 +4412,7 @@ export namespace compute_v1 { */ name?: string; /** - * The party that generated this notification. Note that "NSRC_GOOGLE" has been deprecated in favor of "GOOGLE" + * The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. */ source?: string; /** @@ -4267,7 +4420,7 @@ export namespace compute_v1 { */ startTime?: string; /** - * State of this notification. Note that the "NS_" versions of this enum have been deprecated in favor of the unprefixed values. + * State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values. */ state?: string; } @@ -4451,12 +4604,12 @@ export namespace compute_v1 { */ export interface Schema$LogConfigDataAccessOptions { /** - * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152). + * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. */ logMode?: string; } /** - * A Machine Type resource. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==) + * Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==) */ export interface Schema$MachineType { /** @@ -4675,7 +4828,7 @@ export namespace compute_v1 { port?: number; } /** - * Represents a Network resource. Read Virtual Private Cloud (VPC) Network Overview for more information. (== resource_for v1.networks ==) (== resource_for beta.networks ==) + * Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==) */ export interface Schema$Network { /** @@ -4687,11 +4840,11 @@ export namespace compute_v1 { */ creationTimestamp?: string; /** - * An optional description of this resource. Provide this property when you create the resource. + * An optional description of this resource. Provide this field when you create the resource. */ description?: string; /** - * [Output Only] The gateway address for default routing out of the network. This value is read only and is selected by GCP. + * [Output Only] The gateway address for default routing out of the network, selected by GCP. */ gatewayIPv4?: string; /** @@ -4707,7 +4860,7 @@ export namespace compute_v1 { */ 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 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. */ name?: string; /** @@ -4934,7 +5087,7 @@ export namespace compute_v1 { */ accessConfigs?: Schema$AccessConfig[]; /** - * An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. + * An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. */ aliasIpRanges?: Schema$AliasIpRange[]; /** @@ -4946,19 +5099,19 @@ export namespace compute_v1 { */ kind?: string; /** - * [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. + * [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. */ name?: string; /** - * URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network global/networks/default is used. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/network - projects/project/global/networks/network - global/networks/default + * URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/network - projects/project/global/networks/network - global/networks/default */ network?: string; /** - * An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. + * An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. */ networkIP?: string; /** - * The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - regions/region/subnetworks/subnetwork + * The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - regions/region/subnetworks/subnetwork */ subnetwork?: string; } @@ -5000,15 +5153,15 @@ export namespace compute_v1 { */ export interface Schema$NetworkPeering { /** - * This field will be deprecated soon. Prefer using exchange_subnet_routes instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. + * This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ autoCreateRoutes?: boolean; /** - * Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. + * Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ exchangeSubnetRoutes?: boolean; /** - * Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + * Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string; /** @@ -5016,7 +5169,7 @@ export namespace compute_v1 { */ network?: string; /** - * [Output Only] State for the peering. + * [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. */ state?: string; /** @@ -5029,13 +5182,13 @@ export namespace compute_v1 { */ export interface Schema$NetworkRoutingConfig { /** - * The network-wide routing mode to use. If set to REGIONAL, this network's cloud routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's cloud routers will advertise routes with all subnets of this network, across regions. + * The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. */ routingMode?: string; } export interface Schema$NetworksAddPeeringRequest { /** - * This field will be deprecated soon. Prefer using exchange_subnet_routes in network_peering instead. Whether Google Compute Engine manages the routes automatically. + * This field will be deprecated soon. Use exchange_subnet_routes in network_peering instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. */ autoCreateRoutes?: boolean; /** @@ -5043,7 +5196,7 @@ export namespace compute_v1 { */ name?: string; /** - * Network peering parameters. In order to specify route policies for peering using import/export custom routes, you will have to fill all peering related parameters (name, peer network, exchange_subnet_routes) in network_peeringfield. Corresponding fields in NetworksAddPeeringRequest will be deprecated soon. + * Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon. */ networkPeering?: Schema$NetworkPeering; /** @@ -5058,7 +5211,7 @@ export namespace compute_v1 { name?: string; } /** - * A NodeGroup resource. To create a node group, you must first create a node templates. To learn more about node groups and sole-tenant nodes, read the Sole-tenant nodes documentation. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) + * Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) NextID: 15 */ export interface Schema$NodeGroup { /** @@ -5175,6 +5328,10 @@ export namespace compute_v1 { * The type of this node. */ nodeType?: string; + /** + * Binding properties for the physical server. + */ + serverBinding?: Schema$ServerBinding; status?: string; } export interface Schema$NodeGroupsAddNodesRequest { @@ -5237,7 +5394,7 @@ export namespace compute_v1 { nodeTemplate?: string; } /** - * A Node Template resource. To learn more about node templates and sole-tenant nodes, read the Sole-tenant nodes documentation. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) + * Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) (== NextID: 16 ==) */ export interface Schema$NodeTemplate { /** @@ -5280,6 +5437,10 @@ export namespace compute_v1 { * [Output Only] Server-defined URL for the resource. */ selfLink?: string; + /** + * Sets the binding properties for the physical server. Valid values include: - [Default] RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information. + */ + serverBinding?: Schema$ServerBinding; /** * [Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. */ @@ -5372,7 +5533,7 @@ export namespace compute_v1 { }; } /** - * A Node Type resource. + * Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for beta.nodeTypes ==) (== resource_for v1.nodeTypes ==) */ export interface Schema$NodeType { /** @@ -5502,7 +5663,7 @@ export namespace compute_v1 { }; } /** - * An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) + * Represents an Operation resource. You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) */ export interface Schema$Operation { /** @@ -5560,7 +5721,7 @@ export namespace compute_v1 { */ progress?: number; /** - * [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + * [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. */ region?: string; /** @@ -5600,7 +5761,7 @@ export namespace compute_v1 { message?: string; }>; /** - * [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + * [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. */ zone?: string; } @@ -5742,7 +5903,7 @@ export namespace compute_v1 { version?: number; } /** - * A Project resource. For an overview of projects, see Cloud Platform Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) + * Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) */ export interface Schema$Project { /** @@ -5879,7 +6040,7 @@ export namespace compute_v1 { target?: string; } /** - * Region resource. (== resource_for beta.regions ==) (== resource_for v1.regions ==) + * Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for beta.regions ==) (== resource_for v1.regions ==) */ export interface Schema$Region { /** @@ -5956,6 +6117,18 @@ export namespace compute_v1 { message?: string; }; } + 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. @@ -6206,28 +6379,13 @@ export namespace compute_v1 { policy?: Schema$Policy; } /** - * Commitment for a particular resource (a Commitment is composed of one or more of these). + * Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for beta.reservations ==) (== resource_for v1.reservations ==) (== NextID: 13 ==) */ - export interface Schema$ResourceCommitment { - /** - * The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. - */ - amount?: string; - /** - * Type of resource for which this commitment applies. Possible values are VCPU and MEMORY - */ - type?: string; - } - export interface Schema$ResourceGroupReference { + export interface Schema$Reservation { /** - * A URI referencing one of the instance groups or network endpoint groups listed in the backend service. + * [OutputOnly] Full or partial url for parent commitment for reservations which are tied to a commitment. */ - 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 { + commitment?: string; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -6236,182 +6394,573 @@ export namespace compute_v1 { * 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. + * [Output Only] Type of the resource. Always compute#reservations for reservations. */ 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. + * 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; - /** - * 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. + * Reservation for instances with specific machine shapes. */ - tags?: string[]; - /** - * [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. - */ - warnings?: Array<{ - code?: string; - data?: Array<{key?: string; value?: string}>; - message?: string; - }>; - } - /** - * 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. - */ - kind?: string; + specificReservation?: Schema$AllocationSpecificSKUReservation; /** - * [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. + * Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. */ - nextPageToken?: string; + specificReservationRequired?: boolean; /** - * [Output Only] Server-defined URL for this resource. + * [Output Only] The status of the reservation. */ - selfLink?: string; + status?: string; /** - * [Output Only] Informational warning message. + * Zone in which the reservation resides, must be provided if reservation is created with commitment creation. */ - warning?: { - code?: string; - data?: Array<{key?: string; value?: string}>; - message?: string; - }; + zone?: string; } /** - * Router resource. + * Specifies the reservations that this instance can consume from. */ - export interface Schema$Router { + export interface Schema$ReservationAffinity { /** - * BGP information specific to this router. + * Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples. */ - bgp?: Schema$RouterBgp; + consumeReservationType?: string; /** - * BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273. - */ - bgpPeers?: Schema$RouterBgpPeer[]; - /** - * [Output Only] Creation timestamp in RFC3339 text format. - */ - creationTimestamp?: string; - /** - * An optional description of this resource. Provide this property when you create the resource. + * Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value. */ - description?: string; - /** - * [Output Only] The unique identifier for the resource. This identifier is defined by the server. - */ - id?: string; - /** - * Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both. - */ - interfaces?: Schema$RouterInterface[]; - /** - * [Output Only] Type of resource. Always compute#router for routers. - */ - 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; - /** - * A list of Nat services created in this router. - */ - nats?: Schema$RouterNat[]; - /** - * URI of the network to which this router belongs. - */ - network?: string; - /** - * [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - */ - region?: string; - /** - * [Output Only] Server-defined URL for the resource. - */ - selfLink?: string; - } - /** - * Description-tagged IP ranges for the router to advertise. - */ - export interface Schema$RouterAdvertisedIpRange { - /** - * User-specified description for the IP range. - */ - description?: string; + key?: string; /** - * The IP range to advertise. The value must be a CIDR-formatted string. + * Corresponds to the label values of a reservation resource. */ - range?: string; + values?: string[]; } /** - * Contains a list of routers. + * Contains a list of reservations. */ - export interface Schema$RouterAggregatedList { + export interface Schema$ReservationAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ id?: string; /** - * A list of Router resources. + * A list of Allocation resources. */ - items?: {[key: string]: Schema$RoutersScopedList}; + items?: {[key: string]: Schema$ReservationsScopedList}; + /** + * 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?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } + export interface Schema$ReservationList { + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string; + /** + * [Output Only] A list of Allocation resources. + */ + items?: Schema$Reservation[]; + /** + * [Output Only] Type of resource.Always compute#reservationsList for listsof reservations + */ + 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?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } + export interface Schema$ReservationsResizeRequest { + /** + * Number of allocated resources can be resized with minimum = 1 and maximum = 1000. + */ + specificSkuCount?: string; + } + export interface Schema$ReservationsScopedList { + /** + * A list of reservations contained in this scope. + */ + reservations?: Schema$Reservation[]; + /** + * Informational warning which replaces the list of reservations when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } + /** + * Commitment for a particular resource (a Commitment is composed of one or more of these). + */ + export interface Schema$ResourceCommitment { + /** + * Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. + */ + acceleratorType?: string; + /** + * The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU. + */ + amount?: string; + /** + * Type of resource for which this commitment applies. Possible values are VCPU and MEMORY + */ + type?: string; + } + export interface Schema$ResourceGroupReference { + /** + * A URI referencing one of the instance groups or network endpoint groups listed in the backend service. + */ + group?: string; + } + export interface Schema$ResourcePoliciesScopedList { + /** + * A list of resourcePolicies contained in this scope. + */ + resourcePolicies?: Schema$ResourcePolicy[]; + /** + * Informational warning which replaces the list of resourcePolicies when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } + export interface Schema$ResourcePolicy { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string; + description?: string; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string; + /** + * [Output Only] Type of the resource. Always compute#resource_policies for resource policies. + */ + 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; + region?: string; + /** + * [Output Only] Server-defined fully-qualified URL for this resource. + */ + selfLink?: string; + /** + * Resource policy for persistent disks for creating snapshots. + */ + snapshotSchedulePolicy?: Schema$ResourcePolicySnapshotSchedulePolicy; + /** + * [Output Only] The status of resource policy creation. + */ + status?: string; + } + /** + * Contains a list of resourcePolicies. + */ + export interface Schema$ResourcePolicyAggregatedList { + etag?: string; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of ResourcePolicy resources. + */ + items?: {[key: string]: Schema$ResourcePoliciesScopedList}; + /** + * 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?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } + /** + * Time window specified for daily operations. + */ + export interface Schema$ResourcePolicyDailyCycle { + /** + * Defines a schedule that runs every nth day of the month. + */ + daysInCycle?: number; + /** + * [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario. + */ + duration?: string; + /** + * Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid. + */ + 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-00] GMT. + */ + startTime?: string; + } + export interface Schema$ResourcePolicyList { + etag?: string; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string; + /** + * [Output Only] A list of ResourcePolicy resources. + */ + items?: Schema$ResourcePolicy[]; + /** + * [Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies + */ + 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?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } + /** + * A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained. + */ + export interface Schema$ResourcePolicySnapshotSchedulePolicy { + /** + * Retention policy applied to snapshots created by this resource policy. + */ + retentionPolicy?: Schema$ResourcePolicySnapshotSchedulePolicyRetentionPolicy; + /** + * 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$ResourcePolicySnapshotSchedulePolicySchedule; + /** + * Properties with which snapshots are created such as labels, encryption keys. + */ + snapshotProperties?: Schema$ResourcePolicySnapshotSchedulePolicySnapshotProperties; + } + /** + * Policy for retention of scheduled snapshots. + */ + export interface Schema$ResourcePolicySnapshotSchedulePolicyRetentionPolicy { + /** + * Maximum age of the snapshot that is allowed to be kept. + */ + maxRetentionDays?: number; + /** + * Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. + */ + onSourceDiskDelete?: string; + } + /** + * A schedule for disks where the schedueled operations are performed. + */ + export interface Schema$ResourcePolicySnapshotSchedulePolicySchedule { + dailySchedule?: Schema$ResourcePolicyDailyCycle; + hourlySchedule?: Schema$ResourcePolicyHourlyCycle; + weeklySchedule?: Schema$ResourcePolicyWeeklyCycle; + } + /** + * Specified snapshot properties for scheduled snapshots created by this policy. + */ + export interface Schema$ResourcePolicySnapshotSchedulePolicySnapshotProperties { + /** + * Indication to perform a ?guest aware? snapshot. + */ + guestFlush?: boolean; + /** + * Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty. + */ + labels?: {[key: string]: string}; + /** + * GCS bucket storage location of the auto snapshot (regional or multi-regional). + */ + storageLocations?: 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-00] GMT. + */ + startTime?: string; + } + /** + * Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== 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 field 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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. + */ + 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/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 cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive. + */ + 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?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }>; + } + /** + * 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. + */ + 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?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + }; + } + /** + * Represents a Cloud Router resource. For more information about Cloud Router, read the the Cloud Router overview. + */ + export interface Schema$Router { + /** + * BGP information specific to this router. + */ + bgp?: Schema$RouterBgp; + /** + * BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273. + */ + bgpPeers?: Schema$RouterBgpPeer[]; + /** + * [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; + /** + * Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. + */ + interfaces?: Schema$RouterInterface[]; + /** + * [Output Only] Type of resource. Always compute#router for routers. + */ + 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; + /** + * A list of NAT services created in this router. + */ + nats?: Schema$RouterNat[]; + /** + * URI of the network to which this router belongs. + */ + network?: string; + /** + * [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string; + } + /** + * Description-tagged IP ranges for the router to advertise. + */ + export interface Schema$RouterAdvertisedIpRange { + /** + * User-specified description for the IP range. + */ + description?: string; + /** + * The IP range to advertise. The value must be a CIDR-formatted string. + */ + range?: string; + } + /** + * Contains a list of routers. + */ + export interface Schema$RouterAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of Router resources. + */ + items?: {[key: string]: Schema$RoutersScopedList}; /** * Type of resource. */ @@ -6443,7 +6992,7 @@ export namespace compute_v1 { */ advertisedIpRanges?: Schema$RouterAdvertisedIpRange[]; /** - * User-specified flag to indicate which mode to use for advertisement. + * User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM. */ advertiseMode?: string; /** @@ -6453,15 +7002,15 @@ export namespace compute_v1 { } export interface Schema$RouterBgpPeer { /** - * User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in Bgp message). These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. + * User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. */ advertisedGroups?: string[]; /** - * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in Bgp message). These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. + * User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. */ advertisedIpRanges?: Schema$RouterAdvertisedIpRange[]; /** - * The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win. + * The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win. */ advertisedRoutePriority?: number; /** @@ -6477,7 +7026,7 @@ export namespace compute_v1 { */ ipAddress?: string; /** - * [Output Only] The resource that configures and manages this BGP peer. MANAGED_BY_USER is the default value and can be managed by you or other users; MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google will automatically create, update, and delete this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. + * [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. */ managementType?: string; /** @@ -6485,29 +7034,29 @@ export namespace compute_v1 { */ name?: string; /** - * Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel. + * Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. */ peerAsn?: number; /** - * IP address of the BGP interface outside Google cloud. Only IPv4 is supported. + * IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. */ peerIpAddress?: string; } export interface Schema$RouterInterface { /** - * IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface. + * IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface. */ ipRange?: string; /** - * URI of the linked interconnect attachment. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment. + * URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be either be a VPN tunnel or an Interconnect attachment. */ linkedInterconnectAttachment?: string; /** - * URI of the linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment. + * URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be either a VPN tunnel or an Interconnect attachment. */ linkedVpnTunnel?: string; /** - * [Output Only] The resource that configures and manages this interface. MANAGED_BY_USER is the default value and can be managed by you or other users; MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google will automatically create, update, and delete this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. + * [Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. */ managementType?: string; /** @@ -6557,7 +7106,11 @@ export namespace compute_v1 { */ icmpIdleTimeoutSec?: number; /** - * Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This gets rounded up to the nearest power of 2. Eg. if the value of this field is 50, at least 64 ports will be allocated to a VM. + * Configure logging on this NAT. + */ + logConfig?: Schema$RouterNatLogConfig; + /** + * Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM. */ minPortsPerVm?: number; /** @@ -6565,15 +7118,15 @@ export namespace compute_v1 { */ name?: string; /** - * Specify the NatIpAllocateOption. If it is AUTO_ONLY, then nat_ip should be empty. + * Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. */ natIpAllocateOption?: string; /** - * A list of URLs of the IP resources used for this Nat service. These IPs must be valid static external IP addresses assigned to the project. max_length is subject to change post alpha. + * A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project. */ natIps?: string[]; /** - * Specify the Nat option. If this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region. + * Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region. */ sourceSubnetworkIpRangesToNat?: string; /** @@ -6593,12 +7146,25 @@ export namespace compute_v1 { */ udpIdleTimeoutSec?: number; } + /** + * Configuration of logging on a NAT. + */ + export interface Schema$RouterNatLogConfig { + /** + * Indicates whether or not to export logs. This is false by default. + */ + enable?: boolean; + /** + * Specifies the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. + */ + filter?: string; + } /** * Defines the IP ranges that want to use NAT for a subnetwork. */ export interface Schema$RouterNatSubnetworkToNat { /** - * URL for the subnetwork resource to use NAT. + * URL for the subnetwork resource that will use NAT. */ name?: string; /** @@ -6606,7 +7172,7 @@ export namespace compute_v1 { */ secondaryIpRangeNames?: string[]; /** - * Specify the options for NAT ranges in the Subnetwork. All usages of single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] + * Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] */ sourceIpRangesToNat?: string[]; } @@ -6758,7 +7324,7 @@ export namespace compute_v1 { permissions?: string[]; } /** - * Sets the scheduling options for an Instance. + * Sets the scheduling options for an Instance. NextID: 9 */ export interface Schema$Scheduling { /** @@ -6766,7 +7332,7 @@ export namespace compute_v1 { */ automaticRestart?: boolean; /** - * A set of node affinity and anti-affinity. + * A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. */ nodeAffinities?: Schema$SchedulingNodeAffinity[]; /** @@ -6787,7 +7353,7 @@ export namespace compute_v1 { */ key?: string; /** - * Defines the operation of node selection. + * Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. */ operator?: string; /** @@ -6796,7 +7362,7 @@ export namespace compute_v1 { values?: string[]; } /** - * A security policy is comprised of one or more rules. It can also be associated with one or more 'targets'. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) + * Represents a Cloud Armor Security Policy resource. Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) */ export interface Schema$SecurityPolicy { /** @@ -6934,6 +7500,9 @@ export namespace compute_v1 { */ start?: string; } + export interface Schema$ServerBinding { + type?: string; + } /** * A service account. */ @@ -7017,9 +7586,13 @@ export namespace compute_v1 { keyValue?: string; } /** - * A persistent disk snapshot resource. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) + * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) */ export interface Schema$Snapshot { + /** + * [Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk. + */ + autoCreated?: boolean; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -7065,7 +7638,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. + * Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. */ snapshotEncryptionKey?: Schema$CustomerEncryptionKey; /** @@ -7140,7 +7713,7 @@ export namespace compute_v1 { diskConfigs?: Schema$DiskInstantiationConfig[]; } /** - * An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) + * Represents an SSL Certificate resource. This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) */ export interface Schema$SslCertificate { /** @@ -7269,7 +7842,7 @@ export namespace compute_v1 { features?: string[]; } /** - * A SSL policy specifies the server-side support for SSL features. This can be attached to a TargetHttpsProxy or a TargetSslProxy. This affects connections between clients and the HTTPS or SSL proxy load balancer. They do not affect the connection between the load balancers and the backends. + * Represents a Cloud Armor Security Policy resource. Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for beta.sslPolicies ==) (== resource_for v1.sslPolicies ==) */ export interface Schema$SslPolicy { /** @@ -7332,7 +7905,7 @@ export namespace compute_v1 { sslPolicy?: string; } /** - * A Subnetwork resource. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==) + * Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==) */ export interface Schema$Subnetwork { /** @@ -7505,7 +8078,7 @@ export namespace compute_v1 { items?: string[]; } /** - * A TargetHttpProxy resource. This resource defines an HTTP proxy. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) + * Represents a Target HTTP Proxy resource. A target HTTP proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) */ export interface Schema$TargetHttpProxy { /** @@ -7583,7 +8156,7 @@ export namespace compute_v1 { sslCertificates?: string[]; } /** - * A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) + * Represents a Target HTTPS Proxy resource. A target HTTPS proxy is a component of certain types of load balancers. Global forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) */ export interface Schema$TargetHttpsProxy { /** @@ -7661,7 +8234,7 @@ export namespace compute_v1 { }; } /** - * A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) + * Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) */ export interface Schema$TargetInstance { /** @@ -7779,7 +8352,7 @@ export namespace compute_v1 { }; } /** - * A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) + * Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) */ export interface Schema$TargetPool { /** @@ -7961,7 +8534,7 @@ export namespace compute_v1 { sslCertificates?: string[]; } /** - * A TargetSslProxy resource. This resource defines an SSL proxy. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) + * Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) */ export interface Schema$TargetSslProxy { /** @@ -8051,7 +8624,7 @@ export namespace compute_v1 { proxyHeader?: string; } /** - * A TargetTcpProxy resource. This resource defines a TCP proxy. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) + * Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference ta target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing Concepts. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) */ export interface Schema$TargetTcpProxy { /** @@ -8121,7 +8694,7 @@ export namespace compute_v1 { }; } /** - * Represents a Target VPN gateway resource. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) + * Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) */ export interface Schema$TargetVpnGateway { /** @@ -8291,7 +8864,7 @@ export namespace compute_v1 { permissions?: string[]; } /** - * A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. + * Represents a URL Map resource. A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts. */ export interface Schema$UrlMap { /** @@ -8562,7 +9135,7 @@ export namespace compute_v1 { }; } /** - * VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) + * Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) */ export interface Schema$VpnTunnel { /** @@ -8755,7 +9328,7 @@ export namespace compute_v1 { type?: string; } /** - * A Zone resource. (== resource_for beta.zones ==) (== resource_for v1.zones ==) Next ID: 17 + * Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones. (== resource_for beta.zones ==) (== resource_for v1.zones ==) */ export interface Schema$Zone { /** @@ -9785,7 +10358,7 @@ export namespace compute_v1 { /** * compute.addresses.insert - * @desc Creates an address resource in the specified project using the data included in the request. + * @desc Creates an address resource in the specified project by using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -14068,6 +14641,84 @@ export namespace compute_v1 { this.context = context; } + /** + * 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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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/v1/projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'disk'], + pathParams: ['disk', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.disks.aggregatedList * @desc Retrieves an aggregated list of persistent disks. @@ -14278,7 +14929,7 @@ export namespace compute_v1 { * * @param {object} params Parameters for request * @param {string} params.disk Name of the persistent disk to snapshot. - * @param {boolean=} params.guestFlush + * @param {boolean=} params.guestFlush [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). * @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. @@ -14958,6 +15609,86 @@ export namespace compute_v1 { } } + /** + * 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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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/v1/projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'disk'], + pathParams: ['disk', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.disks.resize * @desc Resizes the specified persistent disk. You can only increase the size of the disk. @@ -15389,6 +16120,35 @@ export namespace compute_v1 { } } + export interface Params$Resource$Disks$Addresourcepolicies + extends StandardParameters { + /** + * 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 extends StandardParameters { /** @@ -15429,7 +16189,7 @@ export namespace compute_v1 { */ disk?: string; /** - * + * [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). */ guestFlush?: boolean; /** @@ -15571,6 +16331,35 @@ export namespace compute_v1 { */ zone?: string; } + export interface Params$Resource$Disks$Removeresourcepolicies + extends StandardParameters { + /** + * 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 extends StandardParameters { /** * Auth client or API Key for the request @@ -18366,7 +19155,7 @@ export namespace compute_v1 { /** * compute.globalAddresses.insert - * @desc Creates an address resource in the specified project using the data included in the request. + * @desc Creates an address resource in the specified project by using the data included in the request. * @example * * // BEFORE RUNNING: * // --------------- @@ -28944,6 +29733,86 @@ export namespace compute_v1 { } } + /** + * compute.instances.getGuestAttributes + * @desc Returns the specified guest attributes entry. + * @alias compute.instances.getGuestAttributes + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.queryPath Specifies the guest attributes path to be queried. + * @param {string=} params.variableKey Specifies the key for the guest attributes entry. + * @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 + */ + getGuestAttributes( + params?: Params$Resource$Instances$Getguestattributes, + options?: MethodOptions + ): GaxiosPromise; + getGuestAttributes( + params: Params$Resource$Instances$Getguestattributes, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getGuestAttributes( + params: Params$Resource$Instances$Getguestattributes, + callback: BodyResponseCallback + ): void; + getGuestAttributes( + callback: BodyResponseCallback + ): void; + getGuestAttributes( + paramsOrCallback?: + | Params$Resource$Instances$Getguestattributes + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Getguestattributes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Getguestattributes; + 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}/instances/{instance}/getGuestAttributes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.instances.getIamPolicy * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. @@ -32268,6 +33137,34 @@ export namespace compute_v1 { */ zone?: string; } + export interface Params$Resource$Instances$Getguestattributes + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Specifies the guest attributes path to be queried. + */ + queryPath?: string; + /** + * Specifies the key for the guest attributes entry. + */ + variableKey?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } export interface Params$Resource$Instances$Getiampolicy extends StandardParameters { /** @@ -42302,7 +43199,7 @@ export namespace compute_v1 { /** * compute.projects.disableXpnResource - * @desc Disable a serivce resource (a.k.a service project) associated with this host project. + * @desc Disable a service resource (also known as service project) associated with this host project. * @example * * // BEFORE RUNNING: * // --------------- @@ -46893,6 +47790,84 @@ export namespace compute_v1 { this.context = context; } + /** + * 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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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/v1/projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.regionDisks.createSnapshot * @desc Creates a snapshot of this regional disk. @@ -47273,6 +48248,86 @@ export namespace compute_v1 { } } + /** + * 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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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/v1/projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.regionDisks.resize * @desc Resizes the specified regional persistent disk. @@ -47511,6 +48566,35 @@ export namespace compute_v1 { } } + export interface Params$Resource$Regiondisks$Addresourcepolicies + extends StandardParameters { + /** + * 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 extends StandardParameters { /** @@ -47643,6 +48727,35 @@ export namespace compute_v1 { */ region?: string; } + export interface Params$Resource$Regiondisks$Removeresourcepolicies + extends StandardParameters { + /** + * 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 extends StandardParameters { /** @@ -51415,6 +52528,1774 @@ export namespace compute_v1 { project?: string; } + export class Resource$Reservations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.reservations.aggregatedList + * @desc Retrieves an aggregated list of reservations. + * @alias compute.reservations.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$Reservations$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Reservations$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Reservations$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Reservations$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$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/reservations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.reservations.delete + * @desc Deletes the specified reservation. + * @alias compute.reservations.delete + * @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 {string} params.reservation Name of the reservation to delete. + * @param {string} params.zone 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$Reservations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Reservations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Reservations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Reservations$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$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}/reservations/{reservation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'reservation'], + pathParams: ['project', 'reservation', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.reservations.get + * @desc Retrieves all information of the specified reservation. + * @alias compute.reservations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.reservation Name of the reservation to retrieve. + * @param {string} params.zone 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$Reservations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Reservations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Reservations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Reservations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Reservations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$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}/reservations/{reservation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'reservation'], + pathParams: ['project', 'reservation', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.reservations.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.reservations.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name or id 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$Reservations$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Reservations$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Reservations$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Reservations$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$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/v1/projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.reservations.insert + * @desc Creates a new reservation. For more information, read Reserving zonal resources. + * @alias compute.reservations.insert + * @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 {string} params.zone Name of the zone for this request. + * @param {().Reservation} 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$Reservations$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Reservations$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Reservations$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Reservations$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$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}/reservations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.reservations.list + * @desc A list all the reservations that have been configured for the specified project in specified zone. + * @alias compute.reservations.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 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$Reservations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Reservations$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Reservations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Reservations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$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}/reservations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.reservations.resize + * @desc Resizes the reservation (applicable to standalone reservations only) + * @alias compute.reservations.resize + * @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 {string} params.reservation Name of the reservation to update. + * @param {string} params.zone Name of the zone for this request. + * @param {().ReservationsResizeRequest} 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 + */ + resize( + params?: Params$Resource$Reservations$Resize, + options?: MethodOptions + ): GaxiosPromise; + resize( + params: Params$Resource$Reservations$Resize, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resize( + params: Params$Resource$Reservations$Resize, + callback: BodyResponseCallback + ): void; + resize(callback: BodyResponseCallback): void; + resize( + paramsOrCallback?: + | Params$Resource$Reservations$Resize + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$Resize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$Resize; + 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}/reservations/{reservation}/resize' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'reservation'], + pathParams: ['project', 'reservation', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.reservations.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.reservations.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name or id 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$Reservations$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Reservations$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Reservations$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Reservations$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$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/v1/projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.reservations.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.reservations.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {string} params.zone The name of the zone 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$Reservations$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Reservations$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Reservations$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Reservations$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservations$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservations$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/v1/projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Reservations$Aggregatedlist + extends StandardParameters { + /** + * 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$Reservations$Delete + extends StandardParameters { + /** + * 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; + /** + * Name of the reservation to delete. + */ + reservation?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Reservations$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the reservation to retrieve. + */ + reservation?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Reservations$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Reservations$Insert + extends StandardParameters { + /** + * 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; + /** + * Name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Reservation; + } + export interface Params$Resource$Reservations$List + extends StandardParameters { + /** + * 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 zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Reservations$Resize + extends StandardParameters { + /** + * 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; + /** + * Name of the reservation to update. + */ + reservation?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReservationsResizeRequest; + } + export interface Params$Resource$Reservations$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id 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$Reservations$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Resourcepolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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/v1/projects/{project}/aggregated/resourcePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + 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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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/v1/projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resourcePolicy'], + pathParams: ['project', 'region', 'resourcePolicy'], + context: this.context, + }; + 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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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/v1/projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resourcePolicy'], + pathParams: ['project', 'region', 'resourcePolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.resourcePolicies.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @alias compute.resourcePolicies.getIamPolicy + * @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 or id 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$Resourcepolicies$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Resourcepolicies$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Resourcepolicies$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Resourcepolicies$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Resourcepolicies$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$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/v1/projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + 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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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/v1/projects/{project}/regions/{region}/resourcePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + 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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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/v1/projects/{project}/regions/{region}/resourcePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.resourcePolicies.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @alias compute.resourcePolicies.setIamPolicy + * @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 or id of the resource for this request. + * @param {().RegionSetPolicyRequest} 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$Resourcepolicies$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Resourcepolicies$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Resourcepolicies$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Resourcepolicies$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Resourcepolicies$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$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/v1/projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + 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 or id 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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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/v1/projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Resourcepolicies$Aggregatedlist + extends StandardParameters { + /** + * 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 + extends StandardParameters { + /** + * 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 + extends StandardParameters { + /** + * 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$Getiampolicy + extends StandardParameters { + /** + * 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 or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Resourcepolicies$Insert + extends StandardParameters { + /** + * 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 + extends StandardParameters { + /** + * 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$Setiampolicy + extends StandardParameters { + /** + * 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 or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Resourcepolicies$Testiampermissions + extends StandardParameters { + /** + * 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 or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export class Resource$Routers { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -52606,7 +55487,7 @@ export namespace compute_v1 { /** * compute.routers.update - * @desc Updates the specified Router resource with the data included in the request. + * @desc Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. * @example * * // BEFORE RUNNING: * // --------------- diff --git a/src/apis/compute/webpack.config.js b/src/apis/compute/webpack.config.js index 233656d78bf..3550ccc5fd7 100644 --- a/src/apis/compute/webpack.config.js +++ b/src/apis/compute/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/container/package.json b/src/apis/container/package.json index b980530cad9..f854c6fc14a 100644 --- a/src/apis/container/package.json +++ b/src/apis/container/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index 6bf7cb2f1e0..7bb831b5fe5 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -143,7 +143,7 @@ export namespace container_v1 { */ httpLoadBalancing?: Schema$HttpLoadBalancing; /** - * Configuration for the Kubernetes Dashboard. + * Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards */ kubernetesDashboard?: Schema$KubernetesDashboard; /** @@ -164,6 +164,15 @@ export namespace container_v1 { */ description?: string; } + /** + * Parameters for using BigQuery as the destination of resource usage export. + */ + export interface Schema$BigQueryDestination { + /** + * The ID of a BigQuery Dataset. + */ + datasetId?: string; + } /** * CancelOperationRequest cancels a single operation. */ @@ -296,7 +305,7 @@ export namespace container_v1 { */ locations?: string[]; /** - * The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com` - the Google Cloud Logging service. * `none` - no logs will be exported from the cluster. * if left as an empty string,`logging.googleapis.com` will be used. + * The logging service the cluster should use to write logs. Currently available options: * "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model in Stackdriver * `logging.googleapis.com` - the Google Cloud Logging service. * `none` - no logs will be exported from the cluster. * if left as an empty string,`logging.googleapis.com` will be used. */ loggingService?: string; /** @@ -336,7 +345,7 @@ export namespace container_v1 { */ nodeConfig?: Schema$NodeConfig; /** - * [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. + * [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. */ nodeIpv4CidrSize?: number; /** @@ -351,6 +360,10 @@ export namespace container_v1 { * The resource labels for the cluster to use to annotate any related Google Compute Engine resources. */ resourceLabels?: {[key: string]: string}; + /** + * Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified. + */ + resourceUsageExportConfig?: Schema$ResourceUsageExportConfig; /** * [Output only] Server-defined URL for the resource. */ @@ -396,6 +409,10 @@ export namespace container_v1 { * The desired list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. */ desiredLocations?: string[]; + /** + * The logging service the cluster should use to write logs. Currently available options: * "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model in Stackdriver * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no logs will be exported from the cluster + */ + desiredLoggingService?: string; /** * The desired configuration options for master authorized networks feature. */ @@ -405,7 +422,7 @@ export namespace container_v1 { */ desiredMasterVersion?: string; /** - * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster + * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model in Stackdriver * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster */ desiredMonitoringService?: string; /** @@ -420,6 +437,10 @@ export namespace container_v1 { * The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version */ desiredNodeVersion?: string; + /** + * The desired configuration for exporting resource usage. + */ + desiredResourceUsageExportConfig?: Schema$ResourceUsageExportConfig; } /** * CompleteIPRotationRequest moves the cluster master back into single-IP mode. @@ -442,6 +463,15 @@ export namespace container_v1 { */ zone?: string; } + /** + * Parameters for controlling consumption metering. + */ + export interface Schema$ConsumptionMeteringConfig { + /** + * Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records. + */ + enabled?: boolean; + } /** * CreateClusterRequest creates a cluster. */ @@ -497,7 +527,7 @@ export namespace container_v1 { */ duration?: string; /** - * Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM”, where HH : [00-23] and MM : [00-59] GMT. + * Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. */ startTime?: string; } @@ -862,7 +892,7 @@ export namespace container_v1 { */ machineType?: string; /** - * The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-os-login" "gci-update-strategy" "gci-ensure-gke-docker" "instance-template" "kube-env" "startup-script" "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. + * The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-os-login" "gci-update-strategy" "gci-ensure-gke-docker" "instance-template" "kube-env" "startup-script" "user-data" "disable-address-manager" "windows-startup-script-ps1" "common-psm1" "k8s-node-setup-psm1" "install-ssh-psm1" "user-profile-psm1" "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. */ metadata?: {[key: string]: string}; /** @@ -1080,6 +1110,23 @@ export namespace container_v1 { */ publicEndpoint?: string; } + /** + * Configuration for exporting cluster resource usages. + */ + export interface Schema$ResourceUsageExportConfig { + /** + * Configuration to use BigQuery as usage export destination. + */ + bigqueryDestination?: Schema$BigQueryDestination; + /** + * Configuration to enable resource consumption metering. + */ + consumptionMeteringConfig?: Schema$ConsumptionMeteringConfig; + /** + * Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. + */ + enableNetworkEgressMetering?: boolean; + } /** * RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed. */ @@ -1322,7 +1369,7 @@ export namespace container_v1 { */ clusterId?: string; /** - * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster + * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model in Stackdriver * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster */ monitoringService?: string; /** @@ -1647,6 +1694,66 @@ export namespace container_v1 { /** * container.projects.aggregated.usableSubnetworks.list * @desc Lists subnetworks that are usable for creating clusters in a project. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The parent project where subnetworks are usable. + * // Specified in the format 'projects/<'. + * parent: 'projects/my-project', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var subnetworksPage = response['subnetworks']; + * if (!subnetworksPage) { + * return; + * } + * for (var i = 0; i < subnetworksPage.length; i++) { + * // TODO: Change code below to process each resource in `subnetworksPage`: + * console.log(JSON.stringify(subnetworksPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * container.projects.aggregated.usableSubnetworks.list(request, handlePage); + * } + * }; + * + * container.projects.aggregated.usableSubnetworks.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.aggregated.usableSubnetworks.list * @memberOf! () * @@ -1770,6 +1877,53 @@ export namespace container_v1 { /** * container.projects.locations.getServerConfig * @desc Returns configuration info about the Google Kubernetes Engine service. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project and location) of the server config to get, + * // specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.getServerConfig * @memberOf! () * @@ -1882,6 +2036,57 @@ export namespace container_v1 { /** * container.projects.locations.clusters.completeIpRotation * @desc Completes master IP rotation. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster id) of the cluster to complete IP + * // rotation. Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.completeIpRotation * @memberOf! () * @@ -1957,6 +2162,57 @@ export namespace container_v1 { /** * container.projects.locations.clusters.create * @desc Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The parent (project and location) where the cluster will be created. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.create * @memberOf! () * @@ -2032,6 +2288,53 @@ export namespace container_v1 { /** * container.projects.locations.clusters.delete * @desc Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster) of the cluster to delete. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.delete * @memberOf! () * @@ -2106,6 +2409,53 @@ export namespace container_v1 { /** * container.projects.locations.clusters.get * @desc Gets the details of a specific cluster. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster) of the cluster to retrieve. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.get * @memberOf! () * @@ -2178,14 +2528,61 @@ export namespace container_v1 { /** * container.projects.locations.clusters.getJwks * @desc Gets the public component of the cluster signing keys in JSON Web Key format. This API is not yet intended for general use, and is not available for all clusters. - * @alias container.projects.locations.clusters.getJwks - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The cluster (project, location, cluster id) to get keys for. Specified in the format 'projects/x/locations/x/clusters/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 + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The cluster (project, location, cluster id) to get keys for. Specified in + * // the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias container.projects.locations.clusters.getJwks + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The cluster (project, location, cluster id) to get keys for. Specified in the format 'projects/x/locations/x/clusters/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 */ getJwks( params?: Params$Resource$Projects$Locations$Clusters$Getjwks, @@ -2253,6 +2650,54 @@ export namespace container_v1 { /** * container.projects.locations.clusters.list * @desc Lists all clusters owned by a project in either the specified zone or all zones. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The parent (project and location) where the clusters will be listed. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.list * @memberOf! () * @@ -2331,6 +2776,57 @@ export namespace container_v1 { /** * container.projects.locations.clusters.setAddons * @desc Sets the addons for a specific cluster. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster) of the cluster to set addons. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.setAddons * @memberOf! () * @@ -2406,6 +2902,57 @@ export namespace container_v1 { /** * container.projects.locations.clusters.setLegacyAbac * @desc Enables or disables the ABAC authorization mechanism on a cluster. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster id) of the cluster to set legacy abac. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.setLegacyAbac * @memberOf! () * @@ -2481,6 +3028,57 @@ export namespace container_v1 { /** * container.projects.locations.clusters.setLocations * @desc Sets the locations for a specific cluster. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster) of the cluster to set locations. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.setLocations * @memberOf! () * @@ -2556,6 +3154,57 @@ export namespace container_v1 { /** * container.projects.locations.clusters.setLogging * @desc Sets the logging service for a specific cluster. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster) of the cluster to set logging. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.setLogging * @memberOf! () * @@ -2631,6 +3280,58 @@ export namespace container_v1 { /** * container.projects.locations.clusters.setMaintenancePolicy * @desc Sets the maintenance policy for a cluster. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster id) of the cluster to set maintenance + * // policy. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.setMaintenancePolicy * @memberOf! () * @@ -2708,6 +3409,57 @@ export namespace container_v1 { /** * container.projects.locations.clusters.setMasterAuth * @desc Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster) of the cluster to set auth. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.setMasterAuth * @memberOf! () * @@ -2783,6 +3535,57 @@ export namespace container_v1 { /** * container.projects.locations.clusters.setMonitoring * @desc Sets the monitoring service for a specific cluster. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster) of the cluster to set monitoring. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.setMonitoring * @memberOf! () * @@ -2858,6 +3661,57 @@ export namespace container_v1 { /** * container.projects.locations.clusters.setNetworkPolicy * @desc Enables or disables Network Policy for a cluster. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster id) of the cluster to set networking + * // policy. Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.setNetworkPolicy * @memberOf! () * @@ -2933,6 +3787,57 @@ export namespace container_v1 { /** * container.projects.locations.clusters.setResourceLabels * @desc Sets labels on a cluster. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster id) of the cluster to set labels. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.setResourceLabels * @memberOf! () * @@ -3008,6 +3913,57 @@ export namespace container_v1 { /** * container.projects.locations.clusters.startIpRotation * @desc Starts master IP rotation. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster id) of the cluster to start IP + * // rotation. Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.startIpRotation * @memberOf! () * @@ -3083,6 +4039,58 @@ export namespace container_v1 { /** * container.projects.locations.clusters.update * @desc Updates the settings of a specific cluster. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster) of the cluster to update. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.update * @memberOf! () * @@ -3155,6 +4163,57 @@ export namespace container_v1 { /** * container.projects.locations.clusters.updateMaster * @desc Updates the master for a specific cluster. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster) of the cluster to update. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.updateMaster * @memberOf! () * @@ -3556,6 +4615,58 @@ export namespace container_v1 { /** * container.projects.locations.clusters.nodePools.create * @desc Creates a node pool for a cluster. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The parent (project, location, cluster id) where the node pool will be + * // created. Specified in the format + * // 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.nodePools.create * @memberOf! () * @@ -3631,6 +4742,54 @@ export namespace container_v1 { /** * container.projects.locations.clusters.nodePools.delete * @desc Deletes a node pool from a cluster. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster, node pool id) of the node pool to + * // delete. Specified in the format + * // 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.nodePools.delete * @memberOf! () * @@ -3706,6 +4865,54 @@ export namespace container_v1 { /** * container.projects.locations.clusters.nodePools.get * @desc Retrieves the requested node pool. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster, node pool id) of the node pool to + * // get. Specified in the format + * // 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.nodePools.get * @memberOf! () * @@ -3779,6 +4986,53 @@ export namespace container_v1 { /** * container.projects.locations.clusters.nodePools.list * @desc Lists the node pools for a cluster. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The parent (project, location, cluster id) where the node pools will be + * // listed. Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.nodePools.list * @memberOf! () * @@ -3858,6 +5112,58 @@ export namespace container_v1 { /** * container.projects.locations.clusters.nodePools.rollback * @desc Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster, node pool id) of the node poll to + * // rollback upgrade. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.nodePools.rollback * @memberOf! () * @@ -3933,6 +5239,58 @@ export namespace container_v1 { /** * container.projects.locations.clusters.nodePools.setAutoscaling * @desc Sets the autoscaling settings for the specified node pool. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster, node pool) of the node pool to set + * // autoscaler settings. Specified in the format + * // 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.nodePools.setAutoscaling * @memberOf! () * @@ -4008,6 +5366,58 @@ export namespace container_v1 { /** * container.projects.locations.clusters.nodePools.setManagement * @desc Sets the NodeManagement options for a node pool. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster, node pool id) of the node pool to set + * // management properties. Specified in the format + * // 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.nodePools.setManagement * @memberOf! () * @@ -4083,6 +5493,58 @@ export namespace container_v1 { /** * container.projects.locations.clusters.nodePools.setSize * @desc Sets the size for a specific node pool. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster, node pool id) of the node pool to set + * // size. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.nodePools.setSize * @memberOf! () * @@ -4158,6 +5620,59 @@ export namespace container_v1 { /** * container.projects.locations.clusters.nodePools.update * @desc Updates the version and/or image type for the specified node pool. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, cluster, node pool) of the node pool to + * // update. Specified in the format + * // 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.nodePools.update * @memberOf! () * @@ -4420,6 +5935,53 @@ export namespace container_v1 { /** * container.projects.locations.clusters.well-known.getOpenid-configuration * @desc Gets the OIDC discovery document for the cluster. See the [OpenID Connect Discovery 1.0 specification](https://openid.net/specs/openid-connect-discovery-1_0.html) for details. This API is not yet intended for general use, and is not available for all clusters. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The cluster (project, location, cluster id) to get the discovery document + * // for. Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.clusters.well-known.getOpenid-configuration * @memberOf! () * @@ -4517,6 +6079,54 @@ export namespace container_v1 { /** * container.projects.locations.operations.cancel * @desc Cancels the specified operation. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, operation id) of the operation to cancel. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.operations.cancel * @memberOf! () * @@ -4587,6 +6197,53 @@ export namespace container_v1 { /** * container.projects.locations.operations.get * @desc Gets the specified operation. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name (project, location, operation id) of the operation to get. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.operations.get * @memberOf! () * @@ -4661,6 +6318,54 @@ export namespace container_v1 { /** * container.projects.locations.operations.list * @desc Lists all operations in a project in a specific zone or all zones. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Kubernetes Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/container + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var container = google.container('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The parent (project and location) where the operations will be listed. + * // Specified in the format 'projects/ { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias container.projects.locations.operations.list * @memberOf! () * @@ -4815,7 +6520,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -4827,17 +6532,19 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine [zone](/compute/docs/zones#available) - * // to return operations for. + * // Deprecated. The name of the Google Compute Engine + * // [zone](/compute/docs/zones#available) to return operations for. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * * auth: authClient, @@ -4855,16 +6562,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.getServerconfig @@ -4977,7 +6680,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -4989,21 +6692,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster to upgrade. + * // Deprecated. The name of the cluster to upgrade. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * resource: { @@ -5025,16 +6731,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.addons @@ -5117,7 +6819,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -5129,21 +6831,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://developers.google.com/console/help/new/#projectnumber). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster. + * // Deprecated. The name of the cluster. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * resource: { @@ -5165,16 +6870,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.completeIpRotation @@ -5257,7 +6958,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -5269,18 +6970,20 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the parent field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the parent field. * zone: 'my-zone', // TODO: Update placeholder value. * * resource: { @@ -5302,16 +7005,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.create @@ -5392,7 +7091,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -5404,21 +7103,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster to delete. + * // Deprecated. The name of the cluster to delete. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * auth: authClient, @@ -5436,16 +7138,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.delete @@ -5528,7 +7226,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -5540,21 +7238,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster to retrieve. + * // Deprecated. The name of the cluster to retrieve. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * auth: authClient, @@ -5572,16 +7273,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.get @@ -5662,7 +7359,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -5674,21 +7371,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster to update. + * // Deprecated. The name of the cluster to update. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * resource: { @@ -5710,16 +7410,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.legacyAbac @@ -5802,7 +7498,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -5814,18 +7510,20 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the parent field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides, or "-" for all zones. + * // This field has been deprecated and replaced by the parent field. * zone: 'my-zone', // TODO: Update placeholder value. * * auth: authClient, @@ -5843,16 +7541,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.list @@ -5935,7 +7629,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -5947,21 +7641,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster to upgrade. + * // Deprecated. The name of the cluster to upgrade. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * resource: { @@ -5983,16 +7680,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.locations @@ -6075,7 +7768,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -6087,21 +7780,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster to upgrade. + * // Deprecated. The name of the cluster to upgrade. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * resource: { @@ -6123,16 +7819,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.logging @@ -6215,7 +7907,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -6227,21 +7919,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster to upgrade. + * // Deprecated. The name of the cluster to upgrade. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * resource: { @@ -6263,16 +7958,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.master @@ -6355,7 +8046,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -6367,21 +8058,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster to upgrade. + * // Deprecated. The name of the cluster to upgrade. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * resource: { @@ -6403,16 +8097,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.monitoring @@ -6495,7 +8185,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -6507,21 +8197,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://developers.google.com/console/help/new/#projectnumber). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster. + * // Deprecated. The name of the cluster. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * resource: { @@ -6543,16 +8236,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.resourceLabels @@ -6635,7 +8324,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -6647,7 +8336,7 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { @@ -6683,16 +8372,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.setMaintenancePolicy @@ -6777,7 +8462,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -6789,21 +8474,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster to upgrade. + * // Deprecated. The name of the cluster to upgrade. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * resource: { @@ -6825,16 +8513,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.setMasterAuth @@ -6917,7 +8601,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -6929,21 +8613,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://developers.google.com/console/help/new/#projectnumber). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster. + * // Deprecated. The name of the cluster. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * resource: { @@ -6965,16 +8652,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.setNetworkPolicy @@ -7057,7 +8740,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -7069,21 +8752,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://developers.google.com/console/help/new/#projectnumber). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster. + * // Deprecated. The name of the cluster. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * resource: { @@ -7105,16 +8791,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.startIpRotation @@ -7197,7 +8879,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -7209,21 +8891,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster to upgrade. + * // Deprecated. The name of the cluster to upgrade. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * resource: { @@ -7246,16 +8931,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.update @@ -7760,7 +9441,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -7772,24 +9453,28 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster to upgrade. + * // Deprecated. The name of the cluster to upgrade. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * - * // The name of the node pool to upgrade. + * // Deprecated. The name of the node pool to upgrade. + * // This field has been deprecated and replaced by the name field. * nodePoolId: 'my-node-pool-id', // TODO: Update placeholder value. * * resource: { @@ -7811,16 +9496,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.nodePools.autoscaling @@ -7904,7 +9585,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -7916,21 +9597,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://developers.google.com/console/help/new/#projectnumber). + * // This field has been deprecated and replaced by the parent field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the parent field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster. + * // Deprecated. The name of the cluster. + * // This field has been deprecated and replaced by the parent field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * resource: { @@ -7952,16 +9636,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.nodePools.create @@ -8044,7 +9724,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -8056,24 +9736,28 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://developers.google.com/console/help/new/#projectnumber). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster. + * // Deprecated. The name of the cluster. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * - * // The name of the node pool to delete. + * // Deprecated. The name of the node pool to delete. + * // This field has been deprecated and replaced by the name field. * nodePoolId: 'my-node-pool-id', // TODO: Update placeholder value. * * auth: authClient, @@ -8091,16 +9775,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.nodePools.delete @@ -8184,7 +9864,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -8196,24 +9876,28 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://developers.google.com/console/help/new/#projectnumber). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster. + * // Deprecated. The name of the cluster. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * - * // The name of the node pool. + * // Deprecated. The name of the node pool. + * // This field has been deprecated and replaced by the name field. * nodePoolId: 'my-node-pool-id', // TODO: Update placeholder value. * * auth: authClient, @@ -8231,16 +9915,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.nodePools.get @@ -8322,7 +10002,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -8334,21 +10014,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://developers.google.com/console/help/new/#projectnumber). + * // This field has been deprecated and replaced by the parent field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the parent field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster. + * // Deprecated. The name of the cluster. + * // This field has been deprecated and replaced by the parent field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * * auth: authClient, @@ -8366,16 +10049,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.nodePools.list @@ -8460,7 +10139,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -8472,24 +10151,28 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster to rollback. + * // Deprecated. The name of the cluster to rollback. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * - * // The name of the node pool to rollback. + * // Deprecated. The name of the node pool to rollback. + * // This field has been deprecated and replaced by the name field. * nodePoolId: 'my-node-pool-id', // TODO: Update placeholder value. * * resource: { @@ -8511,16 +10194,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.nodePools.rollback @@ -8604,7 +10283,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -8616,24 +10295,28 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster to update. + * // Deprecated. The name of the cluster to update. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * - * // The name of the node pool to update. + * // Deprecated. The name of the node pool to update. + * // This field has been deprecated and replaced by the name field. * nodePoolId: 'my-node-pool-id', // TODO: Update placeholder value. * * resource: { @@ -8655,16 +10338,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.nodePools.setManagement @@ -8748,7 +10427,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -8760,24 +10439,28 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster to update. + * // Deprecated. The name of the cluster to update. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * - * // The name of the node pool to update. + * // Deprecated. The name of the node pool to update. + * // This field has been deprecated and replaced by the name field. * nodePoolId: 'my-node-pool-id', // TODO: Update placeholder value. * * resource: { @@ -8799,16 +10482,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.nodePools.setSize @@ -8892,7 +10571,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -8904,24 +10583,28 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the cluster to upgrade. + * // Deprecated. The name of the cluster to upgrade. + * // This field has been deprecated and replaced by the name field. * clusterId: 'my-cluster-id', // TODO: Update placeholder value. * - * // The name of the node pool to upgrade. + * // Deprecated. The name of the node pool to upgrade. + * // This field has been deprecated and replaced by the name field. * nodePoolId: 'my-node-pool-id', // TODO: Update placeholder value. * * resource: { @@ -8943,16 +10626,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.clusters.nodePools.update @@ -9294,7 +10973,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -9306,20 +10985,23 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the operation resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The server-assigned `name` of the operation. + * // Deprecated. The server-assigned `name` of the operation. + * // This field has been deprecated and replaced by the name field. * operationId: 'my-operation-id', // TODO: Update placeholder value. * * resource: { @@ -9338,16 +11020,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.operations.cancel @@ -9428,7 +11106,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -9440,21 +11118,24 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the name field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine + * // Deprecated. The name of the Google Compute Engine * // [zone](/compute/docs/zones#available) in which the cluster * // resides. + * // This field has been deprecated and replaced by the name field. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The server-assigned `name` of the operation. + * // Deprecated. The server-assigned `name` of the operation. + * // This field has been deprecated and replaced by the name field. * operationId: 'my-operation-id', // TODO: Update placeholder value. * * auth: authClient, @@ -9472,16 +11153,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.operations.get @@ -9564,7 +11241,7 @@ export namespace container_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Container Engine API + * // 1. If not already done, enable the Kubernetes Engine API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/container * // 2. This sample uses Application Default Credentials for authentication. @@ -9576,17 +11253,19 @@ export namespace container_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var container = google.container('v1'); * * authorize(function(authClient) { * var request = { - * // The Google Developers Console [project ID or project + * // Deprecated. The Google Developers Console [project ID or project * // number](https://support.google.com/cloud/answer/6158840). + * // This field has been deprecated and replaced by the parent field. * projectId: 'my-project-id', // TODO: Update placeholder value. * - * // The name of the Google Compute Engine [zone](/compute/docs/zones#available) - * // to return operations for, or `-` for all zones. + * // Deprecated. The name of the Google Compute Engine + * // [zone](/compute/docs/zones#available) to return operations for, or `-` for + * // all zones. This field has been deprecated and replaced by the parent field. * zone: 'my-zone', // TODO: Update placeholder value. * * auth: authClient, @@ -9604,16 +11283,12 @@ export namespace container_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias container.projects.zones.operations.list diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 91f7d58387a..efe16497a3a 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -151,7 +151,7 @@ export namespace container_v1beta1 { */ istioConfig?: Schema$IstioConfig; /** - * Configuration for the Kubernetes Dashboard. + * Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards */ kubernetesDashboard?: Schema$KubernetesDashboard; /** @@ -417,7 +417,7 @@ export namespace container_v1beta1 { */ nodeConfig?: Schema$NodeConfig; /** - * [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. + * [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. */ nodeIpv4CidrSize?: number; /** @@ -464,6 +464,10 @@ export namespace container_v1beta1 { * The name of the Google Compute Engine [subnetwork](/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. */ subnetwork?: string; + /** + * Cluster tier settings. + */ + tierSettings?: Schema$TierSettings; /** * [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`). */ @@ -472,6 +476,10 @@ export namespace container_v1beta1 { * Cluster-level Vertical Pod Autoscaling configuration. */ verticalPodAutoscaling?: Schema$VerticalPodAutoscaling; + /** + * Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. + */ + workloadIdentityConfig?: Schema$WorkloadIdentityConfig; /** * [Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. */ @@ -481,6 +489,10 @@ export namespace container_v1beta1 { * ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. */ export interface Schema$ClusterAutoscaling { + /** + * The list of Google Compute Engine [zones](/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + */ + autoprovisioningLocations?: string[]; /** * AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. */ @@ -547,7 +559,7 @@ export namespace container_v1beta1 { */ desiredNodePoolAutoscaling?: Schema$NodePoolAutoscaling; /** - * The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster. + * The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family", "desired_node_pool_autoscaling", or "desired_workload_metadata_config" is specified and there is more than one node pool on the cluster. */ desiredNodePoolId?: string; /** @@ -558,6 +570,10 @@ export namespace container_v1beta1 { * The desired configuration options for the PodSecurityPolicy feature. */ desiredPodSecurityPolicyConfig?: Schema$PodSecurityPolicyConfig; + /** + * The desired private cluster configuration. + */ + desiredPrivateClusterConfig?: Schema$PrivateClusterConfig; /** * The desired configuration for exporting resource usage. */ @@ -566,6 +582,10 @@ export namespace container_v1beta1 { * Cluster-level Vertical Pod Autoscaling configuration. */ desiredVerticalPodAutoscaling?: Schema$VerticalPodAutoscaling; + /** + * Configuration for Workload Identity. + */ + desiredWorkloadIdentityConfig?: Schema$WorkloadIdentityConfig; } /** * CompleteIPRotationRequest moves the cluster master back into single-IP mode. @@ -588,6 +608,15 @@ export namespace container_v1beta1 { */ zone?: string; } + /** + * Parameters for controlling consumption metering. + */ + export interface Schema$ConsumptionMeteringConfig { + /** + * Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records. + */ + enabled?: boolean; + } /** * CreateClusterRequest creates a cluster. */ @@ -643,7 +672,7 @@ export namespace container_v1beta1 { */ duration?: string; /** - * Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM”, where HH : [00-23] and MM : [00-59] GMT. + * Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. */ startTime?: string; } @@ -974,9 +1003,6 @@ export namespace container_v1beta1 { * [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. */ clientKey?: string; - /** - * [Output only] Base64-encoded public certificate that is the root of trust for the cluster. - */ clusterCaCertificate?: string; /** * The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. @@ -1102,7 +1128,7 @@ export namespace container_v1beta1 { */ machineType?: string; /** - * The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-oslogin" "gci-ensure-gke-docker" "gci-update-strategy" "instance-template" "kube-env" "startup-script" "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. + * The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-oslogin" "gci-ensure-gke-docker" "gci-update-strategy" "instance-template" "kube-env" "startup-script" "user-data" "disable-address-manager" "windows-startup-script-ps1" "common-psm1" "k8s-node-setup-psm1" "install-ssh-psm1" "user-profile-psm1" "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. */ metadata?: {[key: string]: string}; /** @@ -1125,6 +1151,10 @@ export namespace container_v1beta1 { * The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used. */ serviceAccount?: string; + /** + * Shielded Instance options. + */ + shieldedInstanceConfig?: Schema$ShieldedInstanceConfig; /** * The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. */ @@ -1179,6 +1209,10 @@ export namespace container_v1beta1 { * [Output only] The resource URLs of the [managed instance groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. */ instanceGroupUrls?: string[]; + /** + * The list of Google Compute Engine [zones](/compute/docs/zones#available) in which the NodePool's nodes should be located. + */ + locations?: string[]; /** * NodeManagement configuration for this NodePool. */ @@ -1345,6 +1379,10 @@ export namespace container_v1beta1 { * Configuration options for private clusters. */ export interface Schema$PrivateClusterConfig { + /** + * Whether to enable route sharing over the network peering. + */ + enablePeeringRouteSharing?: boolean; /** * Whether the master's internal IP address is used as the cluster endpoint. */ @@ -1391,6 +1429,10 @@ export namespace container_v1beta1 { * Configuration to use BigQuery as usage export destination. */ bigqueryDestination?: Schema$BigQueryDestination; + /** + * Configuration to enable resource consumption metering. + */ + consumptionMeteringConfig?: Schema$ConsumptionMeteringConfig; /** * Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. */ @@ -1775,6 +1817,19 @@ export namespace container_v1beta1 { */ zone?: string; } + /** + * A set of Shielded Instance options. + */ + export interface Schema$ShieldedInstanceConfig { + /** + * Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. + */ + enableIntegrityMonitoring?: boolean; + /** + * Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. + */ + enableSecureBoot?: boolean; + } /** * StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP. */ @@ -1813,6 +1868,15 @@ export namespace container_v1beta1 { */ message?: string; } + /** + * Cluster tier settings. + */ + export interface Schema$TierSettings { + /** + * Cluster tier. + */ + tier?: string; + } /** * UpdateClusterRequest updates the settings of a cluster. */ @@ -1875,6 +1939,10 @@ export namespace container_v1beta1 { * The desired image type for the node pool. */ imageType?: string; + /** + * The desired list of Google Compute Engine [zones](/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. + */ + locations?: string[]; /** * The name (project, location, cluster, node pool) of the node pool to update. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ @@ -1891,6 +1959,10 @@ export namespace container_v1beta1 { * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string; + /** + * The desired image type for the node pool. + */ + workloadMetadataConfig?: Schema$WorkloadMetadataConfig; /** * Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ @@ -1947,6 +2019,15 @@ export namespace container_v1beta1 { */ enabled?: boolean; } + /** + * Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. + */ + export interface Schema$WorkloadIdentityConfig { + /** + * IAM Identity Namespace to attach all Kubernetes Service Accounts to. + */ + identityNamespace?: string; + } /** * WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. */ diff --git a/src/apis/container/webpack.config.js b/src/apis/container/webpack.config.js index 49151c10281..ec04794d204 100644 --- a/src/apis/container/webpack.config.js +++ b/src/apis/container/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/containeranalysis/package.json b/src/apis/containeranalysis/package.json index 0463ba92909..4aafbcbe8a6 100644 --- a/src/apis/containeranalysis/package.json +++ b/src/apis/containeranalysis/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index ef9e3564d93..27789df5d9e 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -447,7 +447,7 @@ export namespace containeranalysis_v1alpha1 { */ isObsolete?: boolean; /** - * The max version of the package in which the vulnerability exists. This field can be used as a filter in list requests. + * The max version of the package in which the vulnerability exists. */ maxAffectedVersion?: Schema$Version; /** @@ -580,7 +580,21 @@ export namespace containeranalysis_v1alpha1 { /** * Request message for `GetIamPolicy` method. */ - export interface Schema$GetIamPolicyRequest {} + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + */ + options?: Schema$GetPolicyOptions; + } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + requestedPolicyVersion?: number; + } /** * A summary of how many vulnz occurrences there are per severity type. counts by groups, or if we should have different summary messages like this. */ @@ -936,7 +950,7 @@ export namespace containeranalysis_v1alpha1 { */ remediation?: string; /** - * The resource for which the `Occurrence` applies. + * The resource for which the `Occurrence` applies. */ resource?: Schema$Resource; /** @@ -1081,7 +1095,7 @@ export namespace containeranalysis_v1alpha1 { tagName?: string; } /** - * Resource is an entity that can have metadata. E.g., a Docker image. + * Resource is an entity that can have metadata. E.g., a Docker image. */ export interface Schema$Resource { /** @@ -1178,7 +1192,7 @@ export namespace containeranalysis_v1alpha1 { storageSource?: Schema$StorageSource; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index df04c7d3ed7..ab7e7400a7d 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -501,7 +501,7 @@ export namespace containeranalysis_v1beta1 { */ isObsolete?: boolean; /** - * The max version of the package in which the vulnerability exists. + * Deprecated, do not use. Use fixed_location instead. The max version of the package in which the vulnerability exists. */ maxAffectedVersion?: Schema$Version; /** @@ -702,7 +702,21 @@ export namespace containeranalysis_v1beta1 { /** * Request message for `GetIamPolicy` method. */ - export interface Schema$GetIamPolicyRequest {} + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + */ + options?: Schema$GetPolicyOptions; + } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + requestedPolicyVersion?: number; + } /** * A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). */ @@ -1184,11 +1198,11 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$Resource { /** - * The hash of the resource content. For example, the Docker digest. + * Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest. */ contentHash?: Schema$Hash; /** - * The name of the resource. For example, the name of a Docker image - "Debian". + * Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian". */ name?: string; /** @@ -1290,7 +1304,7 @@ export namespace containeranalysis_v1beta1 { labels?: {[key: string]: string}; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/containeranalysis/webpack.config.js b/src/apis/containeranalysis/webpack.config.js index e70d4d8c90c..42e4970867a 100644 --- a/src/apis/containeranalysis/webpack.config.js +++ b/src/apis/containeranalysis/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/content/package.json b/src/apis/content/package.json index ece982b6e9d..ae3d26c5958 100644 --- a/src/apis/content/package.json +++ b/src/apis/content/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/content/v2.1.ts b/src/apis/content/v2.1.ts index 843bb8a8858..a8a9465ac39 100644 --- a/src/apis/content/v2.1.ts +++ b/src/apis/content/v2.1.ts @@ -745,6 +745,12 @@ export namespace content_v2_1 { */ taxAmount?: Schema$Price; } + export interface Schema$BusinessDayConfig { + /** + * Regular business days. May not be empty. + */ + businessDays?: string[]; + } export interface Schema$CarrierRate { /** * Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required. @@ -1161,6 +1167,10 @@ export namespace content_v2_1 { * Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST. */ cutoffTime?: Schema$CutoffTime; + /** + * The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed. + */ + handlingBusinessDayConfig?: Schema$BusinessDayConfig; /** * Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping. */ @@ -1178,11 +1188,15 @@ export namespace content_v2_1 { */ minHandlingTimeInDays?: number; /** - * Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}transitTimeInDays or transitTimeTable must be set, but not both. + * Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}TransitTimeInDays or transitTimeTable must be set, but not both. */ minTransitTimeInDays?: number; /** - * Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}transitTimeInDays or transitTimeTable can be set, but not both. + * The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed. + */ + transitBusinessDayConfig?: Schema$BusinessDayConfig; + /** + * Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}TransitTimeInDays or transitTimeTable can be set, but not both. */ transitTimeTable?: Schema$TransitTable; } @@ -1643,7 +1657,7 @@ export namespace content_v2_1 { */ customer?: Schema$OrderCustomer; /** - * The details for the delivery. + * Delivery details for shipments. */ deliveryDetails?: Schema$OrderDeliveryDetails; /** @@ -1883,6 +1897,10 @@ export namespace content_v2_1 { reason?: string; } export interface Schema$OrderLineItem { + /** + * Price and tax adjustments applied on the line item. + */ + adjustments?: Schema$OrderLineItemAdjustment[]; /** * Annotations that are attached to the line item. */ @@ -1944,6 +1962,20 @@ export namespace content_v2_1 { */ tax?: Schema$Price; } + export interface Schema$OrderLineItemAdjustment { + /** + * Adjustment for total price of the line item. + */ + priceAdjustment?: Schema$Price; + /** + * Adjustment for total tax of the line item. + */ + taxAdjustment?: Schema$Price; + /** + * Type of this adjustment. + */ + type?: string; + } export interface Schema$OrderLineItemProduct { /** * Brand of the item. @@ -2458,7 +2490,7 @@ export namespace content_v2_1 { } export interface Schema$OrderShipment { /** - * The carrier handling the shipment. Acceptable values for US are: - "gsx" - "ups" - "usps" - "fedex" - "dhl" - "ecourier" - "cxt" - "google" - "ontrac" - "emsy" - "ont" - "deliv" - "dynamex" - "lasership" - "mpx" - "uds" Acceptable values for FR are: - "colissimo" - "chronopost" + * The carrier handling the shipment. Acceptable values for US are: - "gsx" - "ups" - "usps" - "fedex" - "dhl" - "ecourier" - "cxt" - "google" - "ontrac" - "emsy" - "ont" - "deliv" - "dynamex" - "lasership" - "mpx" - "uds" - "efw" Acceptable values for FR are: - "colissimo" - "chronopost" - "gls" - "dpd" - "bpost" */ carrier?: string; /** @@ -3502,6 +3534,10 @@ export namespace content_v2_1 { * An entry ID, unique within the batch request. */ batchId?: number; + /** + * The Content API feed id. + */ + feedId?: string; /** * The ID of the managing account. */ @@ -4212,6 +4248,10 @@ export namespace content_v2_1 { * The two-letter ISO 639-1 language code for the item. */ contentLanguage?: string; + /** + * Fees for the item. Optional. + */ + fees?: Schema$OrderLineItemProductFee[]; /** * Global Trade Item Number (GTIN) of the item. Optional. */ @@ -9557,13 +9597,13 @@ export namespace content_v2_1 { * * @param {object} params Parameters for request * @param {boolean=} params.acknowledged Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned. - * @param {integer=} params.maxResults The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page. Known issue: All List calls will return all Orders without limit regardless of the value of this field. + * @param {integer=} params.maxResults The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page. * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string=} params.orderBy The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria. + * @param {string=} params.orderBy Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc * @param {string=} params.pageToken The token returned by the previous request. * @param {string=} params.placedDateEnd Obtains orders placed before this date (exclusively), in ISO 8601 format. * @param {string=} params.placedDateStart Obtains orders placed after this date (inclusively), in ISO 8601 format. - * @param {string=} params.statuses Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled. + * @param {string=} params.statuses Obtains orders that match any of the specified statuses. Please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped, partiallyDelivered, delivered, partiallyReturned, returned, and canceled. * @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 @@ -10461,7 +10501,7 @@ export namespace content_v2_1 { */ acknowledged?: boolean; /** - * The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page. Known issue: All List calls will return all Orders without limit regardless of the value of this field. + * The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page. */ maxResults?: number; /** @@ -10469,7 +10509,7 @@ export namespace content_v2_1 { */ merchantId?: string; /** - * The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria. + * Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc */ orderBy?: string; /** @@ -10485,7 +10525,7 @@ export namespace content_v2_1 { */ placedDateStart?: string; /** - * Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled. + * Obtains orders that match any of the specified statuses. Please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped, partiallyDelivered, delivered, partiallyReturned, returned, and canceled. */ statuses?: string[]; } @@ -11386,6 +11426,7 @@ export namespace content_v2_1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.feedId The Content API Supplemental Feed ID. * @param {string} params.merchantId The ID of the account that contains the product. This account cannot be a multi-client account. * @param {string} params.productId The REST ID of the product. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11528,6 +11569,7 @@ export namespace content_v2_1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.feedId The Content API Supplemental Feed ID. * @param {string} params.merchantId The ID of the account that contains the product. This account cannot be a multi-client account. * @param {().Product} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11689,6 +11731,10 @@ export namespace content_v2_1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * The Content API Supplemental Feed ID. + */ + feedId?: string; /** * The ID of the account that contains the product. This account cannot be a multi-client account. */ @@ -11719,6 +11765,10 @@ export namespace content_v2_1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * The Content API Supplemental Feed ID. + */ + feedId?: string; /** * The ID of the account that contains the product. This account cannot be a multi-client account. */ diff --git a/src/apis/content/v2.ts b/src/apis/content/v2.ts index 1ffdbcb607b..af79a8f7984 100644 --- a/src/apis/content/v2.ts +++ b/src/apis/content/v2.ts @@ -779,6 +779,12 @@ export namespace content_v2 { */ tax?: Schema$Price; } + export interface Schema$BusinessDayConfig { + /** + * Regular business days. May not be empty. + */ + businessDays?: string[]; + } export interface Schema$CarrierRate { /** * Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required. @@ -1221,6 +1227,10 @@ export namespace content_v2 { * Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST. */ cutoffTime?: Schema$CutoffTime; + /** + * The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed. + */ + handlingBusinessDayConfig?: Schema$BusinessDayConfig; /** * Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping. */ @@ -1238,11 +1248,15 @@ export namespace content_v2 { */ minHandlingTimeInDays?: number; /** - * Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}transitTimeInDays or transitTimeTable must be set, but not both. + * Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}TransitTimeInDays or transitTimeTable must be set, but not both. */ minTransitTimeInDays?: number; /** - * Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}transitTimeInDays or transitTimeTable can be set, but not both. + * The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed. + */ + transitBusinessDayConfig?: Schema$BusinessDayConfig; + /** + * Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}TransitTimeInDays or transitTimeTable can be set, but not both. */ transitTimeTable?: Schema$TransitTable; } @@ -1921,7 +1935,7 @@ export namespace content_v2 { */ customer?: Schema$OrderCustomer; /** - * The details for the delivery. + * Delivery details for shipments. */ deliveryDetails?: Schema$OrderDeliveryDetails; /** @@ -3232,7 +3246,7 @@ export namespace content_v2 { } export interface Schema$OrderShipment { /** - * The carrier handling the shipment. Acceptable values for US are: - "gsx" - "ups" - "usps" - "fedex" - "dhl" - "ecourier" - "cxt" - "google" - "ontrac" - "emsy" - "ont" - "deliv" - "dynamex" - "lasership" - "mpx" - "uds" Acceptable values for FR are: - "colissimo" - "chronopost" + * The carrier handling the shipment. Acceptable values for US are: - "gsx" - "ups" - "usps" - "fedex" - "dhl" - "ecourier" - "cxt" - "google" - "ontrac" - "emsy" - "ont" - "deliv" - "dynamex" - "lasership" - "mpx" - "uds" - "efw" Acceptable values for FR are: - "colissimo" - "chronopost" - "gls" - "dpd" - "bpost" */ carrier?: string; /** @@ -5094,6 +5108,10 @@ export namespace content_v2 { * The two-letter ISO 639-1 language code for the item. */ contentLanguage?: string; + /** + * Fees for the item. Optional. + */ + fees?: Schema$OrderLineItemProductFee[]; /** * Global Trade Item Number (GTIN) of the item. Optional. */ @@ -11676,13 +11694,13 @@ export namespace content_v2 { * * @param {object} params Parameters for request * @param {boolean=} params.acknowledged Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned. - * @param {integer=} params.maxResults The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page. Known issue: All List calls will return all Orders without limit regardless of the value of this field. + * @param {integer=} params.maxResults The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page. * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string=} params.orderBy The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria. + * @param {string=} params.orderBy Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc * @param {string=} params.pageToken The token returned by the previous request. * @param {string=} params.placedDateEnd Obtains orders placed before this date (exclusively), in ISO 8601 format. * @param {string=} params.placedDateStart Obtains orders placed after this date (inclusively), in ISO 8601 format. - * @param {string=} params.statuses Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled. + * @param {string=} params.statuses Obtains orders that match any of the specified statuses. Please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped, partiallyDelivered, delivered, partiallyReturned, returned, and canceled. * @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 @@ -12753,7 +12771,7 @@ export namespace content_v2 { */ acknowledged?: boolean; /** - * The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page. Known issue: All List calls will return all Orders without limit regardless of the value of this field. + * The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page. */ maxResults?: number; /** @@ -12761,7 +12779,7 @@ export namespace content_v2 { */ merchantId?: string; /** - * The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria. + * Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc */ orderBy?: string; /** @@ -12777,7 +12795,7 @@ export namespace content_v2 { */ placedDateStart?: string; /** - * Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled. + * Obtains orders that match any of the specified statuses. Please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped, partiallyDelivered, delivered, partiallyReturned, returned, and canceled. */ statuses?: string[]; } diff --git a/src/apis/content/webpack.config.js b/src/apis/content/webpack.config.js index 5f406383f7d..fe9fa1ba49d 100644 --- a/src/apis/content/webpack.config.js +++ b/src/apis/content/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/customsearch/package.json b/src/apis/customsearch/package.json index 5aabc5284a1..f319e11d14d 100644 --- a/src/apis/customsearch/package.json +++ b/src/apis/customsearch/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/customsearch/webpack.config.js b/src/apis/customsearch/webpack.config.js index 69a7d63b70b..458cbbe2b6a 100644 --- a/src/apis/customsearch/webpack.config.js +++ b/src/apis/customsearch/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/dataflow/package.json b/src/apis/dataflow/package.json index b2ccbaad3c5..51da975aa5f 100644 --- a/src/apis/dataflow/package.json +++ b/src/apis/dataflow/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/dataflow/v1b3.ts b/src/apis/dataflow/v1b3.ts index 807b35f7593..5bd1237da7a 100644 --- a/src/apis/dataflow/v1b3.ts +++ b/src/apis/dataflow/v1b3.ts @@ -882,6 +882,23 @@ export namespace dataflow_v1b3 { */ firstBucketOffset?: number; } + /** + * Proto describing a hot key detected on a given WorkItem. + */ + export interface Schema$HotKeyDetection { + /** + * The age of the hot key measured from when it was first detected. + */ + hotKeyAge?: string; + /** + * System-defined name of the step containing this hot key. Unique across the workflow. + */ + systemName?: string; + /** + * User-provided name of the step that contains this hot key. + */ + userStepName?: string; + } /** * An input of an instruction, as a reference to an output of a producer instruction. */ @@ -1203,6 +1220,14 @@ export namespace dataflow_v1b3 { * The runtime parameters to pass to the job. */ parameters?: {[key: string]: string}; + /** + * Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. + */ + transformNameMapping?: {[key: string]: string}; + /** + * If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state. + */ + update?: boolean; } /** * Response to the request to launch a template. @@ -1760,6 +1785,10 @@ export namespace dataflow_v1b3 { * Whether to bypass the safety checks for the job's temporary directory. Use with caution. */ bypassTempDirValidation?: boolean; + /** + * Optional. Name for the Cloud KMS key for the job. Key format is: projects/<project>/locations/<location>/keyRings/<keyring>/cryptoKeys/<key> + */ + kmsKeyName?: string; /** * The machine type to use for the job. Defaults to the value from the template if not specified. */ @@ -2228,7 +2257,7 @@ export namespace dataflow_v1b3 { stateFamily?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -2931,6 +2960,10 @@ export namespace dataflow_v1b3 { * Other data returned by the service, specific to the particular worker harness. */ harnessData?: {[key: string]: any}; + /** + * A hot key is a symptom of poor data distribution in which there are enough elements mapped to a single key to impact pipeline performance. When present, this field includes metadata associated with any hot key. + */ + hotKeyDetection?: Schema$HotKeyDetection; /** * Time at which the current lease will expire. */ @@ -4659,6 +4692,7 @@ export namespace dataflow_v1b3 { context: APIRequestContext; debug: Resource$Projects$Locations$Jobs$Debug; messages: Resource$Projects$Locations$Jobs$Messages; + snapshots: Resource$Projects$Locations$Jobs$Snapshots; workItems: Resource$Projects$Locations$Jobs$Workitems; constructor(context: APIRequestContext) { this.context = context; @@ -4666,6 +4700,9 @@ export namespace dataflow_v1b3 { this.messages = new Resource$Projects$Locations$Jobs$Messages( this.context ); + this.snapshots = new Resource$Projects$Locations$Jobs$Snapshots( + this.context + ); this.workItems = new Resource$Projects$Locations$Jobs$Workitems( this.context ); @@ -5638,6 +5675,112 @@ export namespace dataflow_v1b3 { startTime?: string; } + export class Resource$Projects$Locations$Jobs$Snapshots { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dataflow.projects.locations.jobs.snapshots.list + * @desc Lists snapshots. + * @alias dataflow.projects.locations.jobs.snapshots.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.jobId If specified, list snapshots created from this job. + * @param {string} params.location The location to list snapshots in. + * @param {string} params.projectId The project ID to list snapshots 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 + */ + list( + params?: Params$Resource$Projects$Locations$Jobs$Snapshots$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Jobs$Snapshots$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Jobs$Snapshots$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Jobs$Snapshots$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Jobs$Snapshots$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Snapshots$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/snapshots' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['projectId', 'location', 'jobId'], + pathParams: ['jobId', 'location', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Jobs$Snapshots$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * If specified, list snapshots created from this job. + */ + jobId?: string; + /** + * The location to list snapshots in. + */ + location?: string; + /** + * The project ID to list snapshots for. + */ + projectId?: string; + } + export class Resource$Projects$Locations$Jobs$Workitems { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -6026,6 +6169,7 @@ export namespace dataflow_v1b3 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.jobId If specified, list snapshots created from this job. * @param {string} params.location The location to list snapshots in. * @param {string} params.projectId The project ID to list snapshots for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6144,6 +6288,10 @@ export namespace dataflow_v1b3 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * If specified, list snapshots created from this job. + */ + jobId?: string; /** * The location to list snapshots in. */ @@ -6667,6 +6815,7 @@ export namespace dataflow_v1b3 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.jobId If specified, list snapshots created from this job. * @param {string=} params.location The location to list snapshots in. * @param {string} params.projectId The project ID to list snapshots for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6765,6 +6914,10 @@ export namespace dataflow_v1b3 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * If specified, list snapshots created from this job. + */ + jobId?: string; /** * The location to list snapshots in. */ diff --git a/src/apis/dataflow/webpack.config.js b/src/apis/dataflow/webpack.config.js index 9452ea593e4..aff0e4500e7 100644 --- a/src/apis/dataflow/webpack.config.js +++ b/src/apis/dataflow/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/datafusion/package.json b/src/apis/datafusion/package.json index 7d1f07d2d12..6c137a11981 100644 --- a/src/apis/datafusion/package.json +++ b/src/apis/datafusion/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/datafusion/v1beta1.ts b/src/apis/datafusion/v1beta1.ts index 7bb1bd24dc3..0b9a5c96062 100644 --- a/src/apis/datafusion/v1beta1.ts +++ b/src/apis/datafusion/v1beta1.ts @@ -569,7 +569,7 @@ export namespace datafusion_v1beta1 { updateMask?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/datafusion/webpack.config.js b/src/apis/datafusion/webpack.config.js index 05569ca5773..a8a36374899 100644 --- a/src/apis/datafusion/webpack.config.js +++ b/src/apis/datafusion/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/dataproc/package.json b/src/apis/dataproc/package.json index 2921149a274..32c8277d123 100644 --- a/src/apis/dataproc/package.json +++ b/src/apis/dataproc/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index 8d6105e3b66..6e12179b668 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -216,6 +216,10 @@ export namespace dataproc_v1 { * Optional. The Compute Engine config settings for additional worker instances in a cluster. */ secondaryWorkerConfig?: Schema$InstanceGroupConfig; + /** + * Optional. Security settings for the cluster. + */ + securityConfig?: Schema$SecurityConfig; /** * Optional. The config settings for software inside the cluster. */ @@ -697,6 +701,67 @@ export namespace dataproc_v1 { */ substate?: string; } + /** + * Specifies Kerberos related configuration. + */ + export interface Schema$KerberosConfig { + /** + * Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship. + */ + crossRealmTrustAdminServer?: string; + /** + * Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship. + */ + crossRealmTrustKdc?: string; + /** + * Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust. + */ + crossRealmTrustRealm?: string; + /** + * Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship. + */ + crossRealmTrustSharedPasswordUri?: string; + /** + * Optional. Flag to indicate whether to Kerberize the cluster. + */ + enableKerberos?: boolean; + /** + * Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database. + */ + kdcDbKeyUri?: string; + /** + * Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc. + */ + keyPasswordUri?: string; + /** + * Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc. + */ + keystorePasswordUri?: string; + /** + * Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate. + */ + keystoreUri?: string; + /** + * Required. The uri of the KMS key used to encrypt various sensitive files. + */ + kmsKeyUri?: string; + /** + * Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password. + */ + rootPrincipalPasswordUri?: string; + /** + * Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used. + */ + tgtLifetimeHours?: number; + /** + * Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc. + */ + truststorePasswordUri?: string; + /** + * Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate. + */ + truststoreUri?: string; + } /** * The list of all clusters in a project. */ @@ -818,7 +883,7 @@ export namespace dataproc_v1 { */ metadata?: {[key: string]: 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. + * 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 be a resource name ending with operations/{unique_id}. */ name?: string; /** @@ -989,6 +1054,15 @@ export namespace dataproc_v1 { */ regexes?: string[]; } + /** + * Security related configuration, including Kerberos. + */ + export interface Schema$SecurityConfig { + /** + * Kerberos related configuration. + */ + kerberosConfig?: Schema$KerberosConfig; + } /** * Request message for SetIamPolicy method. */ @@ -1082,7 +1156,7 @@ export namespace dataproc_v1 { scriptVariables?: {[key: string]: string}; } /** - * 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 needsOverviewThe 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 mappingThe 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 usesThe 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. + * 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). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -1353,6 +1427,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.locations.autoscalingPolicies.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/autoscalingPolicies/my-autoscaling-policy', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.autoscalingPolicies.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.locations.autoscalingPolicies.getIamPolicy * @memberOf! () * @@ -1426,6 +1551,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.locations.autoscalingPolicies.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/autoscalingPolicies/my-autoscaling-policy', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.autoscalingPolicies.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.locations.autoscalingPolicies.setIamPolicy * @memberOf! () * @@ -1499,6 +1675,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.locations.autoscalingPolicies.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. See the operation + * // documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/autoscalingPolicies/my-autoscaling-policy', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.autoscalingPolicies.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.locations.autoscalingPolicies.testIamPermissions * @memberOf! () * @@ -1640,6 +1867,58 @@ export namespace dataproc_v1 { /** * dataproc.projects.locations.workflowTemplates.create * @desc Creates new workflow template. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the region, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region} + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.locations.workflowTemplates.create * @memberOf! () * @@ -1715,6 +1994,51 @@ export namespace dataproc_v1 { /** * dataproc.projects.locations.workflowTemplates.delete * @desc Deletes a workflow template. It does not cancel in-progress workflows. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the workflow template, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * name: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.locations.workflowTemplates.delete * @memberOf! () * @@ -1785,24 +2109,72 @@ export namespace dataproc_v1 { /** * dataproc.projects.locations.workflowTemplates.get * @desc Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. - * @alias dataproc.projects.locations.workflowTemplates.get - * @memberOf! () + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` * - * @param {object} params Parameters for request - * @param {string} params.name Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} - * @param {integer=} params.version Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version. - * @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$Workflowtemplates$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Workflowtemplates$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the workflow template, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * name: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias dataproc.projects.locations.workflowTemplates.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * @param {integer=} params.version Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version. + * @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$Workflowtemplates$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Workflowtemplates$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( params: Params$Resource$Projects$Locations$Workflowtemplates$Get, @@ -1857,6 +2229,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.locations.workflowTemplates.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.locations.workflowTemplates.getIamPolicy * @memberOf! () * @@ -1930,6 +2353,58 @@ export namespace dataproc_v1 { /** * dataproc.projects.locations.workflowTemplates.instantiate * @desc Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the workflow template, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * name: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.instantiate(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.locations.workflowTemplates.instantiate * @memberOf! () * @@ -2005,6 +2480,58 @@ export namespace dataproc_v1 { /** * dataproc.projects.locations.workflowTemplates.instantiateInline * @desc Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the workflow template region, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region} + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.instantiateInline(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.locations.workflowTemplates.instantiateInline * @memberOf! () * @@ -2080,6 +2607,67 @@ export namespace dataproc_v1 { /** * dataproc.projects.locations.workflowTemplates.list * @desc Lists workflows that match the specified filter in the request. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the region, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region} + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var templatesPage = response['templates']; + * if (!templatesPage) { + * return; + * } + * for (var i = 0; i < templatesPage.length; i++) { + * // TODO: Change code below to process each resource in `templatesPage`: + * console.log(JSON.stringify(templatesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dataproc.projects.locations.workflowTemplates.list(request, handlePage); + * } + * }; + * + * dataproc.projects.locations.workflowTemplates.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.locations.workflowTemplates.list * @memberOf! () * @@ -2165,6 +2753,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.locations.workflowTemplates.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.locations.workflowTemplates.setIamPolicy * @memberOf! () * @@ -2238,6 +2877,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.locations.workflowTemplates.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. See the operation + * // documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.locations.workflowTemplates.testIamPermissions * @memberOf! () * @@ -2320,6 +3010,59 @@ export namespace dataproc_v1 { /** * dataproc.projects.locations.workflowTemplates.update * @desc Updates (replaces) workflow template. The updated template must contain version that matches the current server version. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Output only. The "resource name" of the template, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * name: 'projects/my-project/locations/my-location/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.locations.workflowTemplates.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.locations.workflowTemplates.update * @memberOf! () * @@ -2596,6 +3339,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.autoscalingPolicies.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/regions/my-region/autoscalingPolicies/my-autoscaling-policy', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.autoscalingPolicies.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.autoscalingPolicies.getIamPolicy * @memberOf! () * @@ -2669,6 +3463,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.autoscalingPolicies.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/regions/my-region/autoscalingPolicies/my-autoscaling-policy', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.autoscalingPolicies.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.autoscalingPolicies.setIamPolicy * @memberOf! () * @@ -2742,6 +3587,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.autoscalingPolicies.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. See the operation + * // documentation for the appropriate value for this field. + * resource_: 'projects/my-project/regions/my-region/autoscalingPolicies/my-autoscaling-policy', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.autoscalingPolicies.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.autoscalingPolicies.testIamPermissions * @memberOf! () * @@ -2886,7 +3782,7 @@ export namespace dataproc_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Dataproc API + * // 1. If not already done, enable the Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc * // 2. This sample uses Application Default Credentials for authentication. @@ -2898,7 +3794,7 @@ export namespace dataproc_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dataproc = google.dataproc('v1'); * * authorize(function(authClient) { @@ -2928,16 +3824,12 @@ export namespace dataproc_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dataproc.projects.regions.clusters.create @@ -3019,7 +3911,7 @@ export namespace dataproc_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Dataproc API + * // 1. If not already done, enable the Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc * // 2. This sample uses Application Default Credentials for authentication. @@ -3031,7 +3923,7 @@ export namespace dataproc_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dataproc = google.dataproc('v1'); * * authorize(function(authClient) { @@ -3060,16 +3952,12 @@ export namespace dataproc_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dataproc.projects.regions.clusters.delete @@ -3153,7 +4041,7 @@ export namespace dataproc_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Dataproc API + * // 1. If not already done, enable the Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc * // 2. This sample uses Application Default Credentials for authentication. @@ -3165,7 +4053,7 @@ export namespace dataproc_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dataproc = google.dataproc('v1'); * * authorize(function(authClient) { @@ -3198,16 +4086,12 @@ export namespace dataproc_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dataproc.projects.regions.clusters.diagnose @@ -3290,7 +4174,7 @@ export namespace dataproc_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Dataproc API + * // 1. If not already done, enable the Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc * // 2. This sample uses Application Default Credentials for authentication. @@ -3302,7 +4186,7 @@ export namespace dataproc_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dataproc = google.dataproc('v1'); * * authorize(function(authClient) { @@ -3331,16 +4215,12 @@ export namespace dataproc_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dataproc.projects.regions.clusters.get @@ -3417,6 +4297,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.clusters.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/regions/my-region/clusters/my-cluster', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.clusters.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.clusters.getIamPolicy * @memberOf! () * @@ -3493,7 +4424,7 @@ export namespace dataproc_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Dataproc API + * // 1. If not already done, enable the Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc * // 2. This sample uses Application Default Credentials for authentication. @@ -3505,7 +4436,7 @@ export namespace dataproc_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dataproc = google.dataproc('v1'); * * authorize(function(authClient) { @@ -3544,16 +4475,12 @@ export namespace dataproc_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dataproc.projects.regions.clusters.list @@ -3638,7 +4565,7 @@ export namespace dataproc_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Dataproc API + * // 1. If not already done, enable the Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc * // 2. This sample uses Application Default Credentials for authentication. @@ -3650,7 +4577,7 @@ export namespace dataproc_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dataproc = google.dataproc('v1'); * * authorize(function(authClient) { @@ -3684,16 +4611,12 @@ export namespace dataproc_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dataproc.projects.regions.clusters.patch @@ -3776,6 +4699,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.clusters.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/regions/my-region/clusters/my-cluster', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.clusters.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.clusters.setIamPolicy * @memberOf! () * @@ -3849,6 +4823,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.clusters.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. See the operation + * // documentation for the appropriate value for this field. + * resource_: 'projects/my-project/regions/my-region/clusters/my-cluster', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.clusters.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.clusters.testIamPermissions * @memberOf! () * @@ -4156,7 +5181,7 @@ export namespace dataproc_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Dataproc API + * // 1. If not already done, enable the Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc * // 2. This sample uses Application Default Credentials for authentication. @@ -4168,7 +5193,7 @@ export namespace dataproc_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dataproc = google.dataproc('v1'); * * authorize(function(authClient) { @@ -4201,16 +5226,12 @@ export namespace dataproc_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dataproc.projects.regions.jobs.cancel @@ -4291,7 +5312,7 @@ export namespace dataproc_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Dataproc API + * // 1. If not already done, enable the Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc * // 2. This sample uses Application Default Credentials for authentication. @@ -4303,7 +5324,7 @@ export namespace dataproc_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dataproc = google.dataproc('v1'); * * authorize(function(authClient) { @@ -4329,16 +5350,12 @@ export namespace dataproc_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dataproc.projects.regions.jobs.delete @@ -4417,7 +5434,7 @@ export namespace dataproc_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Dataproc API + * // 1. If not already done, enable the Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc * // 2. This sample uses Application Default Credentials for authentication. @@ -4429,7 +5446,7 @@ export namespace dataproc_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dataproc = google.dataproc('v1'); * * authorize(function(authClient) { @@ -4458,16 +5475,12 @@ export namespace dataproc_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dataproc.projects.regions.jobs.get @@ -4543,6 +5556,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.jobs.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/regions/my-region/jobs/my-job', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.jobs.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.jobs.getIamPolicy * @memberOf! () * @@ -4619,7 +5683,7 @@ export namespace dataproc_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Dataproc API + * // 1. If not already done, enable the Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc * // 2. This sample uses Application Default Credentials for authentication. @@ -4631,7 +5695,7 @@ export namespace dataproc_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dataproc = google.dataproc('v1'); * * authorize(function(authClient) { @@ -4670,16 +5734,12 @@ export namespace dataproc_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dataproc.projects.regions.jobs.list @@ -4764,7 +5824,7 @@ export namespace dataproc_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Dataproc API + * // 1. If not already done, enable the Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc * // 2. This sample uses Application Default Credentials for authentication. @@ -4776,7 +5836,7 @@ export namespace dataproc_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dataproc = google.dataproc('v1'); * * authorize(function(authClient) { @@ -4810,16 +5870,12 @@ export namespace dataproc_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dataproc.projects.regions.jobs.patch @@ -4897,6 +5953,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.jobs.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/regions/my-region/jobs/my-job', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.jobs.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.jobs.setIamPolicy * @memberOf! () * @@ -4973,7 +6080,7 @@ export namespace dataproc_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Dataproc API + * // 1. If not already done, enable the Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc * // 2. This sample uses Application Default Credentials for authentication. @@ -4985,7 +6092,7 @@ export namespace dataproc_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dataproc = google.dataproc('v1'); * * authorize(function(authClient) { @@ -5015,16 +6122,12 @@ export namespace dataproc_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dataproc.projects.regions.jobs.submit @@ -5100,6 +6203,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.jobs.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. See the operation + * // documentation for the appropriate value for this field. + * resource_: 'projects/my-project/regions/my-region/jobs/my-job', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.jobs.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.jobs.testIamPermissions * @memberOf! () * @@ -5395,7 +6549,7 @@ export namespace dataproc_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Dataproc API + * // 1. If not already done, enable the Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc * // 2. This sample uses Application Default Credentials for authentication. @@ -5407,7 +6561,7 @@ export namespace dataproc_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dataproc = google.dataproc('v1'); * * authorize(function(authClient) { @@ -5425,18 +6579,14 @@ export namespace dataproc_v1 { * } * }); * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dataproc.projects.regions.operations.cancel @@ -5511,7 +6661,7 @@ export namespace dataproc_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Dataproc API + * // 1. If not already done, enable the Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc * // 2. This sample uses Application Default Credentials for authentication. @@ -5523,7 +6673,7 @@ export namespace dataproc_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dataproc = google.dataproc('v1'); * * authorize(function(authClient) { @@ -5543,16 +6693,12 @@ export namespace dataproc_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dataproc.projects.regions.operations.delete @@ -5627,7 +6773,7 @@ export namespace dataproc_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Dataproc API + * // 1. If not already done, enable the Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc * // 2. This sample uses Application Default Credentials for authentication. @@ -5639,7 +6785,7 @@ export namespace dataproc_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dataproc = google.dataproc('v1'); * * authorize(function(authClient) { @@ -5662,16 +6808,12 @@ export namespace dataproc_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dataproc.projects.regions.operations.get @@ -5745,6 +6887,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.operations.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/regions/my-region/operations/my-operation', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.operations.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.operations.getIamPolicy * @memberOf! () * @@ -5821,7 +7014,7 @@ export namespace dataproc_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Dataproc API + * // 1. If not already done, enable the Cloud Dataproc API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/dataproc * // 2. This sample uses Application Default Credentials for authentication. @@ -5833,7 +7026,7 @@ export namespace dataproc_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dataproc = google.dataproc('v1'); * * authorize(function(authClient) { @@ -5869,16 +7062,12 @@ export namespace dataproc_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dataproc.projects.regions.operations.list @@ -5957,6 +7146,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.operations.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/regions/my-region/operations/my-operation', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.operations.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.operations.setIamPolicy * @memberOf! () * @@ -6030,6 +7270,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.operations.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. See the operation + * // documentation for the appropriate value for this field. + * resource_: 'projects/my-project/regions/my-region/operations/my-operation', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.operations.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.operations.testIamPermissions * @memberOf! () * @@ -6231,6 +7522,58 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.create * @desc Creates new workflow template. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the region, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region} + * parent: 'projects/my-project/regions/my-region', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.workflowTemplates.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.workflowTemplates.create * @memberOf! () * @@ -6306,6 +7649,51 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.delete * @desc Deletes a workflow template. It does not cancel in-progress workflows. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the workflow template, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * name: 'projects/my-project/regions/my-region/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.workflowTemplates.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.workflowTemplates.delete * @memberOf! () * @@ -6376,6 +7764,54 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.get * @desc Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the workflow template, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * name: 'projects/my-project/regions/my-region/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.workflowTemplates.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.workflowTemplates.get * @memberOf! () * @@ -6448,6 +7884,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/regions/my-region/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.workflowTemplates.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.workflowTemplates.getIamPolicy * @memberOf! () * @@ -6521,6 +8008,58 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.instantiate * @desc Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the workflow template, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * name: 'projects/my-project/regions/my-region/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.workflowTemplates.instantiate(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.workflowTemplates.instantiate * @memberOf! () * @@ -6596,6 +8135,58 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.instantiateInline * @desc Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the workflow template region, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region} + * parent: 'projects/my-project/regions/my-region', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.workflowTemplates.instantiateInline(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.workflowTemplates.instantiateInline * @memberOf! () * @@ -6671,6 +8262,67 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.list * @desc Lists workflows that match the specified filter in the request. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The "resource name" of the region, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region} + * parent: 'projects/my-project/regions/my-region', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var templatesPage = response['templates']; + * if (!templatesPage) { + * return; + * } + * for (var i = 0; i < templatesPage.length; i++) { + * // TODO: Change code below to process each resource in `templatesPage`: + * console.log(JSON.stringify(templatesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dataproc.projects.regions.workflowTemplates.list(request, handlePage); + * } + * }; + * + * dataproc.projects.regions.workflowTemplates.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.workflowTemplates.list * @memberOf! () * @@ -6756,6 +8408,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. See the operation documentation for + * // the appropriate value for this field. + * resource_: 'projects/my-project/regions/my-region/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.workflowTemplates.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.workflowTemplates.setIamPolicy * @memberOf! () * @@ -6829,6 +8532,57 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. See the operation + * // documentation for the appropriate value for this field. + * resource_: 'projects/my-project/regions/my-region/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.workflowTemplates.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.workflowTemplates.testIamPermissions * @memberOf! () * @@ -6911,6 +8665,59 @@ export namespace dataproc_v1 { /** * dataproc.projects.regions.workflowTemplates.update * @desc Updates (replaces) workflow template. The updated template must contain version that matches the current server version. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Dataproc API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dataproc + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dataproc = google.dataproc('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Output only. The "resource name" of the template, as described in + * // https://cloud.google.com/apis/design/resource_names of the form + * // projects/{project_id}/regions/{region}/workflowTemplates/{template_id} + * name: 'projects/my-project/regions/my-region/workflowTemplates/my-workflow-template', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dataproc.projects.regions.workflowTemplates.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias dataproc.projects.regions.workflowTemplates.update * @memberOf! () * diff --git a/src/apis/dataproc/v1beta2.ts b/src/apis/dataproc/v1beta2.ts index ceada8e8771..134c52809b3 100644 --- a/src/apis/dataproc/v1beta2.ts +++ b/src/apis/dataproc/v1beta2.ts @@ -1048,7 +1048,7 @@ export namespace dataproc_v1beta2 { */ metadata?: {[key: string]: 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. + * 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 be a resource name ending with operations/{unique_id}. */ name?: string; /** @@ -1400,7 +1400,7 @@ export namespace dataproc_v1beta2 { scriptVariables?: {[key: string]: string}; } /** - * 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 needsOverviewThe 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 mappingThe 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 usesThe 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. + * 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). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -1962,7 +1962,7 @@ export namespace dataproc_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of results to return in each response. + * @param {integer=} params.pageSize Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100. * @param {string=} params.pageToken Optional. The page token, returned by a previous call, to request the next page of results. * @param {string} params.parent Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2329,7 +2329,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return in each response. + * Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100. */ pageSize?: number; /** @@ -3648,7 +3648,7 @@ export namespace dataproc_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of results to return in each response. + * @param {integer=} params.pageSize Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100. * @param {string=} params.pageToken Optional. The page token, returned by a previous call, to request the next page of results. * @param {string} params.parent Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4015,7 +4015,7 @@ export namespace dataproc_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The maximum number of results to return in each response. + * Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100. */ pageSize?: number; /** diff --git a/src/apis/dataproc/webpack.config.js b/src/apis/dataproc/webpack.config.js index 1410552a066..f16565d3851 100644 --- a/src/apis/dataproc/webpack.config.js +++ b/src/apis/dataproc/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/datastore/package.json b/src/apis/datastore/package.json index 8143b275784..68b85d1e1fe 100644 --- a/src/apis/datastore/package.json +++ b/src/apis/datastore/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/datastore/webpack.config.js b/src/apis/datastore/webpack.config.js index 1bf545795be..9763224253b 100644 --- a/src/apis/datastore/webpack.config.js +++ b/src/apis/datastore/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/deploymentmanager/package.json b/src/apis/deploymentmanager/package.json index 163cd4602b1..92e920f7bfa 100644 --- a/src/apis/deploymentmanager/package.json +++ b/src/apis/deploymentmanager/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/deploymentmanager/webpack.config.js b/src/apis/deploymentmanager/webpack.config.js index 686993ddcea..7ac27a9cc86 100644 --- a/src/apis/deploymentmanager/webpack.config.js +++ b/src/apis/deploymentmanager/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/dfareporting/package.json b/src/apis/dfareporting/package.json index dd2d3420814..de046614b95 100644 --- a/src/apis/dfareporting/package.json +++ b/src/apis/dfareporting/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/dfareporting/v3.1.ts b/src/apis/dfareporting/v3.1.ts index 908616271b1..5ef8adf8c7c 100644 --- a/src/apis/dfareporting/v3.1.ts +++ b/src/apis/dfareporting/v3.1.ts @@ -6464,6 +6464,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accountActiveAdSummaries.get * @desc Gets the account's active ad summary by account ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Account ID. + * summaryAccountId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.accountActiveAdSummaries.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.accountActiveAdSummaries.get * @memberOf! () * @@ -6565,6 +6613,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accountPermissionGroups.get * @desc Gets one account permission group by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Account permission group ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.accountPermissionGroups.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.accountPermissionGroups.get * @memberOf! () * @@ -6642,6 +6738,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accountPermissionGroups.list * @desc Retrieves the list of account permission groups. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.accountPermissionGroups.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.accountPermissionGroups.list * @memberOf! () * @@ -6763,6 +6904,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accountPermissions.get * @desc Gets one account permission by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Account permission ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.accountPermissions.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.accountPermissions.get * @memberOf! () * @@ -6838,6 +7027,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accountPermissions.list * @desc Retrieves the list of account permissions. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.accountPermissions.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.accountPermissions.list * @memberOf! () * @@ -6957,6 +7191,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accounts.get * @desc Gets one account by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Account ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.accounts.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.accounts.get * @memberOf! () * @@ -7029,6 +7311,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accounts.list * @desc Retrieves the list of accounts, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var accountsPage = response['accounts']; + * if (!accountsPage) { + * return; + * } + * for (var i = 0; i < accountsPage.length; i++) { + * // TODO: Change code below to process each resource in `accountsPage`: + * console.log(JSON.stringify(accountsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.accounts.list(request, handlePage); + * } + * }; + * + * dfareporting.accounts.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.accounts.list * @memberOf! () * @@ -7110,6 +7450,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accounts.patch * @desc Updates an existing account. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Account ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.accounts.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.accounts.patch * @memberOf! () * @@ -7182,6 +7575,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accounts.update * @desc Updates an existing account. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.accounts.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.accounts.update * @memberOf! () * @@ -7351,6 +7794,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accountUserProfiles.get * @desc Gets one account user profile by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // User profile ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.accountUserProfiles.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.accountUserProfiles.get * @memberOf! () * @@ -7426,6 +7917,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accountUserProfiles.insert * @desc Inserts a new account user profile. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.accountUserProfiles.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.accountUserProfiles.insert * @memberOf! () * @@ -7501,6 +8041,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accountUserProfiles.list * @desc Retrieves a list of account user profiles, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var accountUserProfilesPage = response['accountUserProfiles']; + * if (!accountUserProfilesPage) { + * return; + * } + * for (var i = 0; i < accountUserProfilesPage.length; i++) { + * // TODO: Change code below to process each resource in `accountUserProfilesPage`: + * console.log(JSON.stringify(accountUserProfilesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.accountUserProfiles.list(request, handlePage); + * } + * }; + * + * dfareporting.accountUserProfiles.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.accountUserProfiles.list * @memberOf! () * @@ -7593,6 +8191,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accountUserProfiles.patch * @desc Updates an existing account user profile. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // User profile ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.accountUserProfiles.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.accountUserProfiles.patch * @memberOf! () * @@ -7669,6 +8320,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.accountUserProfiles.update * @desc Updates an existing account user profile. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.accountUserProfiles.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.accountUserProfiles.update * @memberOf! () * @@ -7871,6 +8572,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.ads.get * @desc Gets one ad by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Ad ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.ads.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.ads.get * @memberOf! () * @@ -7942,6 +8691,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.ads.insert * @desc Inserts a new ad. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.ads.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.ads.insert * @memberOf! () * @@ -8013,6 +8811,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.ads.list * @desc Retrieves a list of ads, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var adsPage = response['ads']; + * if (!adsPage) { + * return; + * } + * for (var i = 0; i < adsPage.length; i++) { + * // TODO: Change code below to process each resource in `adsPage`: + * console.log(JSON.stringify(adsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.ads.list(request, handlePage); + * } + * }; + * + * dfareporting.ads.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.ads.list * @memberOf! () * @@ -8108,6 +8964,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.ads.patch * @desc Updates an existing ad. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Ad ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.ads.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.ads.patch * @memberOf! () * @@ -8180,6 +9089,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.ads.update * @desc Updates an existing ad. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.ads.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.ads.update * @memberOf! () * @@ -8429,6 +9388,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertiserGroups.delete * @desc Deletes an existing advertiser group. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Advertiser group ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.advertiserGroups.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.advertiserGroups.delete * @memberOf! () * @@ -8502,6 +9506,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertiserGroups.get * @desc Gets one advertiser group by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Advertiser group ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.advertiserGroups.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.advertiserGroups.get * @memberOf! () * @@ -8577,6 +9629,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertiserGroups.insert * @desc Inserts a new advertiser group. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.advertiserGroups.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.advertiserGroups.insert * @memberOf! () * @@ -8652,6 +9753,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertiserGroups.list * @desc Retrieves a list of advertiser groups, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var advertiserGroupsPage = response['advertiserGroups']; + * if (!advertiserGroupsPage) { + * return; + * } + * for (var i = 0; i < advertiserGroupsPage.length; i++) { + * // TODO: Change code below to process each resource in `advertiserGroupsPage`: + * console.log(JSON.stringify(advertiserGroupsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.advertiserGroups.list(request, handlePage); + * } + * }; + * + * dfareporting.advertiserGroups.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.advertiserGroups.list * @memberOf! () * @@ -8741,6 +9900,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertiserGroups.patch * @desc Updates an existing advertiser group. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Advertiser group ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.advertiserGroups.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.advertiserGroups.patch * @memberOf! () * @@ -8817,6 +10029,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertiserGroups.update * @desc Updates an existing advertiser group. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.advertiserGroups.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.advertiserGroups.update * @memberOf! () * @@ -9023,6 +10285,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertiserLandingPages.get * @desc Gets one landing page by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Landing page ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.advertiserLandingPages.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.advertiserLandingPages.get * @memberOf! () * @@ -9098,6 +10408,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertiserLandingPages.insert * @desc Inserts a new landing page. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.advertiserLandingPages.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.advertiserLandingPages.insert * @memberOf! () * @@ -9173,6 +10532,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertiserLandingPages.list * @desc Retrieves a list of landing pages. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var landingPagesPage = response['landingPages']; + * if (!landingPagesPage) { + * return; + * } + * for (var i = 0; i < landingPagesPage.length; i++) { + * // TODO: Change code below to process each resource in `landingPagesPage`: + * console.log(JSON.stringify(landingPagesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.advertiserLandingPages.list(request, handlePage); + * } + * }; + * + * dfareporting.advertiserLandingPages.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.advertiserLandingPages.list * @memberOf! () * @@ -9265,6 +10682,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertiserLandingPages.patch * @desc Updates an existing landing page. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Landing page ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.advertiserLandingPages.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.advertiserLandingPages.patch * @memberOf! () * @@ -9341,6 +10811,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertiserLandingPages.update * @desc Updates an existing landing page. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.advertiserLandingPages.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.advertiserLandingPages.update * @memberOf! () * @@ -9543,6 +11063,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertisers.get * @desc Gets one advertiser by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Advertiser ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.advertisers.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.advertisers.get * @memberOf! () * @@ -9617,7 +11185,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertisers.insert * @desc Inserts a new advertiser. - * @alias dfareporting.advertisers.insert + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.advertisers.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } + * @alias dfareporting.advertisers.insert * @memberOf! () * * @param {object} params Parameters for request @@ -9692,6 +11309,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertisers.list * @desc Retrieves a list of advertisers, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var advertisersPage = response['advertisers']; + * if (!advertisersPage) { + * return; + * } + * for (var i = 0; i < advertisersPage.length; i++) { + * // TODO: Change code below to process each resource in `advertisersPage`: + * console.log(JSON.stringify(advertisersPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.advertisers.list(request, handlePage); + * } + * }; + * + * dfareporting.advertisers.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.advertisers.list * @memberOf! () * @@ -9779,6 +11454,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertisers.patch * @desc Updates an existing advertiser. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Advertiser ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.advertisers.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.advertisers.patch * @memberOf! () * @@ -9855,6 +11583,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.advertisers.update * @desc Updates an existing advertiser. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.advertisers.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.advertisers.update * @memberOf! () * @@ -10067,6 +11845,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.browsers.list * @desc Retrieves a list of browsers. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.browsers.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.browsers.list * @memberOf! () * @@ -10160,6 +11983,58 @@ export namespace dfareporting_v3_1 { /** * dfareporting.campaignCreativeAssociations.insert * @desc Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Campaign ID in this association. + * campaignId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.campaignCreativeAssociations.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.campaignCreativeAssociations.insert * @memberOf! () * @@ -10243,6 +12118,67 @@ export namespace dfareporting_v3_1 { /** * dfareporting.campaignCreativeAssociations.list * @desc Retrieves the list of creative IDs associated with the specified campaign. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Campaign ID in this association. + * campaignId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var campaignCreativeAssociationsPage = response['campaignCreativeAssociations']; + * if (!campaignCreativeAssociationsPage) { + * return; + * } + * for (var i = 0; i < campaignCreativeAssociationsPage.length; i++) { + * // TODO: Change code below to process each resource in `campaignCreativeAssociationsPage`: + * console.log(JSON.stringify(campaignCreativeAssociationsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.campaignCreativeAssociations.list(request, handlePage); + * } + * }; + * + * dfareporting.campaignCreativeAssociations.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.campaignCreativeAssociations.list * @memberOf! () * @@ -10395,6 +12331,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.campaigns.get * @desc Gets one campaign by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Campaign ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.campaigns.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.campaigns.get * @memberOf! () * @@ -10467,6 +12451,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.campaigns.insert * @desc Inserts a new campaign. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.campaigns.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.campaigns.insert * @memberOf! () * @@ -10538,6 +12571,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.campaigns.list * @desc Retrieves a list of campaigns, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var campaignsPage = response['campaigns']; + * if (!campaignsPage) { + * return; + * } + * for (var i = 0; i < campaignsPage.length; i++) { + * // TODO: Change code below to process each resource in `campaignsPage`: + * console.log(JSON.stringify(campaignsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.campaigns.list(request, handlePage); + * } + * }; + * + * dfareporting.campaigns.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.campaigns.list * @memberOf! () * @@ -10625,6 +12716,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.campaigns.patch * @desc Updates an existing campaign. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Campaign ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.campaigns.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.campaigns.patch * @memberOf! () * @@ -10697,6 +12841,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.campaigns.update * @desc Updates an existing campaign. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.campaigns.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.campaigns.update * @memberOf! () * @@ -10906,6 +13100,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.changeLogs.get * @desc Gets one change log by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Change log ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.changeLogs.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.changeLogs.get * @memberOf! () * @@ -10980,6 +13222,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.changeLogs.list * @desc Retrieves a list of change logs. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var changeLogsPage = response['changeLogs']; + * if (!changeLogsPage) { + * return; + * } + * for (var i = 0; i < changeLogsPage.length; i++) { + * // TODO: Change code below to process each resource in `changeLogsPage`: + * console.log(JSON.stringify(changeLogsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.changeLogs.list(request, handlePage); + * } + * }; + * + * dfareporting.changeLogs.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.changeLogs.list * @memberOf! () * @@ -11138,6 +13438,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.cities.list * @desc Retrieves a list of cities, possibly filtered. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.cities.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.cities.list * @memberOf! () * @@ -11249,6 +13594,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.connectionTypes.get * @desc Gets one connection type by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Connection type ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.connectionTypes.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.connectionTypes.get * @memberOf! () * @@ -11324,6 +13717,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.connectionTypes.list * @desc Retrieves a list of connection types. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.connectionTypes.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.connectionTypes.list * @memberOf! () * @@ -11441,6 +13879,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.contentCategories.delete * @desc Deletes an existing content category. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Content category ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.contentCategories.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.contentCategories.delete * @memberOf! () * @@ -11514,6 +13997,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.contentCategories.get * @desc Gets one content category by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Content category ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.contentCategories.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.contentCategories.get * @memberOf! () * @@ -11589,6 +14120,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.contentCategories.insert * @desc Inserts a new content category. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.contentCategories.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.contentCategories.insert * @memberOf! () * @@ -11664,6 +14244,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.contentCategories.list * @desc Retrieves a list of content categories, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var contentCategoriesPage = response['contentCategories']; + * if (!contentCategoriesPage) { + * return; + * } + * for (var i = 0; i < contentCategoriesPage.length; i++) { + * // TODO: Change code below to process each resource in `contentCategoriesPage`: + * console.log(JSON.stringify(contentCategoriesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.contentCategories.list(request, handlePage); + * } + * }; + * + * dfareporting.contentCategories.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.contentCategories.list * @memberOf! () * @@ -11753,6 +14391,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.contentCategories.patch * @desc Updates an existing content category. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Content category ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.contentCategories.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.contentCategories.patch * @memberOf! () * @@ -11829,6 +14520,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.contentCategories.update * @desc Updates an existing content category. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.contentCategories.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.contentCategories.update * @memberOf! () * @@ -12035,6 +14776,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.conversions.batchinsert * @desc Inserts conversions. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.conversions.batchinsert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/ddmconversions' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.conversions.batchinsert * @memberOf! () * @@ -12119,6 +14909,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.conversions.batchupdate * @desc Updates existing conversions. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.conversions.batchupdate(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/ddmconversions' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.conversions.batchupdate * @memberOf! () * @@ -12245,6 +15084,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.countries.get * @desc Gets one country by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Country DART ID. + * dartId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.countries.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.countries.get * @memberOf! () * @@ -12317,6 +15204,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.countries.list * @desc Retrieves a list of countries. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.countries.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.countries.list * @memberOf! () * @@ -12425,6 +15357,65 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeAssets.insert * @desc Inserts a new creative asset. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Advertiser ID of this creative. This is a required field. + * advertiserId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * media: { + * // TODO: Add desired media content for upload. See + * // https://github.com/google/google-api-nodejs-client#media-uploads + * mimeType: '', // See https://www.w3.org/Protocols/rfc1341/4_Content-Type.html + * body: '', + * }, + * + * auth: authClient, + * }; + * + * dfareporting.creativeAssets.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeAssets.insert * @memberOf! () * @@ -12554,6 +15545,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeFields.delete * @desc Deletes an existing creative field. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Creative Field ID + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.creativeFields.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeFields.delete * @memberOf! () * @@ -12627,6 +15663,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeFields.get * @desc Gets one creative field by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Creative Field ID + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.creativeFields.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeFields.get * @memberOf! () * @@ -12702,6 +15786,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeFields.insert * @desc Inserts a new creative field. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.creativeFields.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeFields.insert * @memberOf! () * @@ -12777,7 +15910,65 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeFields.list * @desc Retrieves a list of creative fields, possibly filtered. This method supports paging. - * @alias dfareporting.creativeFields.list + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var creativeFieldsPage = response['creativeFields']; + * if (!creativeFieldsPage) { + * return; + * } + * for (var i = 0; i < creativeFieldsPage.length; i++) { + * // TODO: Change code below to process each resource in `creativeFieldsPage`: + * console.log(JSON.stringify(creativeFieldsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.creativeFields.list(request, handlePage); + * } + * }; + * + * dfareporting.creativeFields.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } + * @alias dfareporting.creativeFields.list * @memberOf! () * * @param {object} params Parameters for request @@ -12865,6 +16056,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeFields.patch * @desc Updates an existing creative field. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Creative Field ID + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.creativeFields.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeFields.patch * @memberOf! () * @@ -12941,6 +16185,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeFields.update * @desc Updates an existing creative field. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.creativeFields.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeFields.update * @memberOf! () * @@ -13151,6 +16445,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeFieldValues.delete * @desc Deletes an existing creative field value. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Creative field ID for this creative field value. + * creativeFieldId: '0', // TODO: Update placeholder value. + * + * // Creative Field Value ID + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.creativeFieldValues.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeFieldValues.delete * @memberOf! () * @@ -13225,6 +16567,57 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeFieldValues.get * @desc Gets one creative field value by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Creative field ID for this creative field value. + * creativeFieldId: '0', // TODO: Update placeholder value. + * + * // Creative Field Value ID + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.creativeFieldValues.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeFieldValues.get * @memberOf! () * @@ -13301,6 +16694,58 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeFieldValues.insert * @desc Inserts a new creative field value. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Creative field ID for this creative field value. + * creativeFieldId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.creativeFieldValues.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeFieldValues.insert * @memberOf! () * @@ -13377,6 +16822,67 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeFieldValues.list * @desc Retrieves a list of creative field values, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Creative field ID for this creative field value. + * creativeFieldId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var creativeFieldValuesPage = response['creativeFieldValues']; + * if (!creativeFieldValuesPage) { + * return; + * } + * for (var i = 0; i < creativeFieldValuesPage.length; i++) { + * // TODO: Change code below to process each resource in `creativeFieldValuesPage`: + * console.log(JSON.stringify(creativeFieldValuesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.creativeFieldValues.list(request, handlePage); + * } + * }; + * + * dfareporting.creativeFieldValues.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeFieldValues.list * @memberOf! () * @@ -13467,6 +16973,62 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeFieldValues.patch * @desc Updates an existing creative field value. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Creative field ID for this creative field value. + * creativeFieldId: '0', // TODO: Update placeholder value. + * + * // Creative Field Value ID + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.creativeFieldValues.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeFieldValues.patch * @memberOf! () * @@ -13544,6 +17106,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeFieldValues.update * @desc Updates an existing creative field value. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Creative field ID for this creative field value. + * creativeFieldId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.creativeFieldValues.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeFieldValues.update * @memberOf! () * @@ -13775,6 +17390,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeGroups.get * @desc Gets one creative group by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Creative group ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.creativeGroups.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeGroups.get * @memberOf! () * @@ -13850,6 +17513,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeGroups.insert * @desc Inserts a new creative group. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.creativeGroups.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeGroups.insert * @memberOf! () * @@ -13925,6 +17637,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeGroups.list * @desc Retrieves a list of creative groups, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var creativeGroupsPage = response['creativeGroups']; + * if (!creativeGroupsPage) { + * return; + * } + * for (var i = 0; i < creativeGroupsPage.length; i++) { + * // TODO: Change code below to process each resource in `creativeGroupsPage`: + * console.log(JSON.stringify(creativeGroupsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.creativeGroups.list(request, handlePage); + * } + * }; + * + * dfareporting.creativeGroups.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeGroups.list * @memberOf! () * @@ -14014,6 +17784,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeGroups.patch * @desc Updates an existing creative group. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Creative group ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.creativeGroups.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeGroups.patch * @memberOf! () * @@ -14090,6 +17913,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creativeGroups.update * @desc Updates an existing creative group. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.creativeGroups.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creativeGroups.update * @memberOf! () * @@ -14288,6 +18161,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creatives.get * @desc Gets one creative by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Creative ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.creatives.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creatives.get * @memberOf! () * @@ -14360,6 +18281,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creatives.insert * @desc Inserts a new creative. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.creatives.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creatives.insert * @memberOf! () * @@ -14431,6 +18401,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creatives.list * @desc Retrieves a list of creatives, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var creativesPage = response['creatives']; + * if (!creativesPage) { + * return; + * } + * for (var i = 0; i < creativesPage.length; i++) { + * // TODO: Change code below to process each resource in `creativesPage`: + * console.log(JSON.stringify(creativesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.creatives.list(request, handlePage); + * } + * }; + * + * dfareporting.creatives.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creatives.list * @memberOf! () * @@ -14521,6 +18549,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creatives.patch * @desc Updates an existing creative. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Creative ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.creatives.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creatives.patch * @memberOf! () * @@ -14593,6 +18674,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.creatives.update * @desc Updates an existing creative. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.creatives.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.creatives.update * @memberOf! () * @@ -14814,6 +18945,68 @@ export namespace dfareporting_v3_1 { /** * dfareporting.dimensionValues.query * @desc Retrieves list of report dimension values for a list of filters. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // The DFA user profile ID. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var itemsPage = response['items']; + * if (!itemsPage) { + * return; + * } + * for (var i = 0; i < itemsPage.length; i++) { + * // TODO: Change code below to process each resource in `itemsPage`: + * console.log(JSON.stringify(itemsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.dimensionValues.query(request, handlePage); + * } + * }; + * + * dfareporting.dimensionValues.query(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfareporting' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.dimensionValues.query * @memberOf! () * @@ -14924,6 +19117,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.directorySiteContacts.get * @desc Gets one directory site contact by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Directory site contact ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.directorySiteContacts.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.directorySiteContacts.get * @memberOf! () * @@ -15001,6 +19242,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.directorySiteContacts.list * @desc Retrieves a list of directory site contacts, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var directorySiteContactsPage = response['directorySiteContacts']; + * if (!directorySiteContactsPage) { + * return; + * } + * for (var i = 0; i < directorySiteContactsPage.length; i++) { + * // TODO: Change code below to process each resource in `directorySiteContactsPage`: + * console.log(JSON.stringify(directorySiteContactsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.directorySiteContacts.list(request, handlePage); + * } + * }; + * + * dfareporting.directorySiteContacts.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.directorySiteContacts.list * @memberOf! () * @@ -15155,6 +19454,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.directorySites.get * @desc Gets one directory site by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Directory site ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.directorySites.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.directorySites.get * @memberOf! () * @@ -15230,6 +19577,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.directorySites.insert * @desc Inserts a new directory site. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.directorySites.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.directorySites.insert * @memberOf! () * @@ -15305,6 +19701,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.directorySites.list * @desc Retrieves a list of directory sites, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var directorySitesPage = response['directorySites']; + * if (!directorySitesPage) { + * return; + * } + * for (var i = 0; i < directorySitesPage.length; i++) { + * // TODO: Change code below to process each resource in `directorySitesPage`: + * console.log(JSON.stringify(directorySitesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.directorySites.list(request, handlePage); + * } + * }; + * + * dfareporting.directorySites.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.directorySites.list * @memberOf! () * @@ -15504,6 +19958,58 @@ export namespace dfareporting_v3_1 { /** * dfareporting.dynamicTargetingKeys.delete * @desc Deletes an existing dynamic targeting key. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // ID of the object of this dynamic targeting key. This is a required field. + * objectId: '0', // TODO: Update placeholder value. + * + * // Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long + * // and cannot contain commas. All characters are converted to lowercase. + * name: '', // TODO: Update placeholder value. + * + * // Type of the object of this dynamic targeting key. This is a required field. + * objectType: '', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.dynamicTargetingKeys.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.dynamicTargetingKeys.delete * @memberOf! () * @@ -15579,6 +20085,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.dynamicTargetingKeys.insert * @desc Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.dynamicTargetingKeys.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.dynamicTargetingKeys.insert * @memberOf! () * @@ -15654,6 +20209,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.dynamicTargetingKeys.list * @desc Retrieves a list of dynamic targeting keys. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.dynamicTargetingKeys.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.dynamicTargetingKeys.list * @memberOf! () * @@ -15818,6 +20418,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.eventTags.delete * @desc Deletes an existing event tag. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Event tag ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.eventTags.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.eventTags.delete * @memberOf! () * @@ -15890,14 +20535,62 @@ export namespace dfareporting_v3_1 { /** * dfareporting.eventTags.get * @desc Gets one event tag by ID. - * @alias dfareporting.eventTags.get - * @memberOf! () + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` * - * @param {object} params Parameters for request - * @param {string} params.id Event tag ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Event tag ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.eventTags.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } + * @alias dfareporting.eventTags.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Event tag ID. + * @param {string} params.profileId User profile ID associated with 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( @@ -15962,6 +20655,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.eventTags.insert * @desc Inserts a new event tag. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.eventTags.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.eventTags.insert * @memberOf! () * @@ -16033,6 +20775,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.eventTags.list * @desc Retrieves a list of event tags, possibly filtered. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.eventTags.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.eventTags.list * @memberOf! () * @@ -16117,6 +20904,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.eventTags.patch * @desc Updates an existing event tag. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Event tag ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.eventTags.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.eventTags.patch * @memberOf! () * @@ -16189,6 +21029,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.eventTags.update * @desc Updates an existing event tag. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.eventTags.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.eventTags.update * @memberOf! () * @@ -16401,6 +21291,58 @@ export namespace dfareporting_v3_1 { /** * dfareporting.files.get * @desc Retrieves a report file by its report ID and file ID. This method supports media download. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // The ID of the report. + * reportId: '0', // TODO: Update placeholder value. + * + * // The ID of the report file. + * fileId: '0', // TODO: Update placeholder value. + * + * // TODO: To download media content, use: + * // + * // alt: 'media', + * + * auth: authClient, + * }; + * + * dfareporting.files.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfareporting' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.files.get * @memberOf! () * @@ -16472,6 +21414,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.files.list * @desc Lists files for a user profile. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // The DFA profile ID. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var itemsPage = response['items']; + * if (!itemsPage) { + * return; + * } + * for (var i = 0; i < itemsPage.length; i++) { + * // TODO: Change code below to process each resource in `itemsPage`: + * console.log(JSON.stringify(itemsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.files.list(request, handlePage); + * } + * }; + * + * dfareporting.files.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfareporting' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.files.list * @memberOf! () * @@ -16601,6 +21601,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightActivities.delete * @desc Deletes an existing floodlight activity. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Floodlight activity ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.floodlightActivities.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.floodlightActivities.delete * @memberOf! () * @@ -16674,6 +21719,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightActivities.generatetag * @desc Generates a tag for a floodlight activity. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.floodlightActivities.generatetag(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.floodlightActivities.generatetag * @memberOf! () * @@ -16766,6 +21856,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightActivities.get * @desc Gets one floodlight activity by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Floodlight activity ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.floodlightActivities.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.floodlightActivities.get * @memberOf! () * @@ -16841,6 +21979,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightActivities.insert * @desc Inserts a new floodlight activity. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.floodlightActivities.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.floodlightActivities.insert * @memberOf! () * @@ -16916,6 +22103,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightActivities.list * @desc Retrieves a list of floodlight activities, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var floodlightActivitiesPage = response['floodlightActivities']; + * if (!floodlightActivitiesPage) { + * return; + * } + * for (var i = 0; i < floodlightActivitiesPage.length; i++) { + * // TODO: Change code below to process each resource in `floodlightActivitiesPage`: + * console.log(JSON.stringify(floodlightActivitiesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.floodlightActivities.list(request, handlePage); + * } + * }; + * + * dfareporting.floodlightActivities.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.floodlightActivities.list * @memberOf! () * @@ -17012,6 +22257,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightActivities.patch * @desc Updates an existing floodlight activity. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Floodlight activity ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.floodlightActivities.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.floodlightActivities.patch * @memberOf! () * @@ -17088,6 +22386,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightActivities.update * @desc Updates an existing floodlight activity. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.floodlightActivities.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.floodlightActivities.update * @memberOf! () * @@ -17338,6 +22686,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightActivityGroups.get * @desc Gets one floodlight activity group by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Floodlight activity Group ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.floodlightActivityGroups.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.floodlightActivityGroups.get * @memberOf! () * @@ -17415,6 +22811,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightActivityGroups.insert * @desc Inserts a new floodlight activity group. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.floodlightActivityGroups.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.floodlightActivityGroups.insert * @memberOf! () * @@ -17494,6 +22939,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightActivityGroups.list * @desc Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var floodlightActivityGroupsPage = response['floodlightActivityGroups']; + * if (!floodlightActivityGroupsPage) { + * return; + * } + * for (var i = 0; i < floodlightActivityGroupsPage.length; i++) { + * // TODO: Change code below to process each resource in `floodlightActivityGroupsPage`: + * console.log(JSON.stringify(floodlightActivityGroupsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.floodlightActivityGroups.list(request, handlePage); + * } + * }; + * + * dfareporting.floodlightActivityGroups.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.floodlightActivityGroups.list * @memberOf! () * @@ -17594,6 +23097,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightActivityGroups.patch * @desc Updates an existing floodlight activity group. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Floodlight activity Group ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.floodlightActivityGroups.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.floodlightActivityGroups.patch * @memberOf! () * @@ -17672,6 +23228,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightActivityGroups.update * @desc Updates an existing floodlight activity group. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.floodlightActivityGroups.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.floodlightActivityGroups.update * @memberOf! () * @@ -17878,6 +23484,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightConfigurations.get * @desc Gets one floodlight configuration by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Floodlight configuration ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.floodlightConfigurations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.floodlightConfigurations.get * @memberOf! () * @@ -17955,6 +23609,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightConfigurations.list * @desc Retrieves a list of floodlight configurations, possibly filtered. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.floodlightConfigurations.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.floodlightConfigurations.list * @memberOf! () * @@ -18047,6 +23746,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightConfigurations.patch * @desc Updates an existing floodlight configuration. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Floodlight configuration ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.floodlightConfigurations.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.floodlightConfigurations.patch * @memberOf! () * @@ -18125,6 +23877,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.floodlightConfigurations.update * @desc Updates an existing floodlight configuration. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.floodlightConfigurations.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.floodlightConfigurations.update * @memberOf! () * @@ -18282,6 +24084,57 @@ export namespace dfareporting_v3_1 { /** * dfareporting.inventoryItems.get * @desc Gets one inventory item by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Project ID for order documents. + * projectId: '0', // TODO: Update placeholder value. + * + * // Inventory item ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.inventoryItems.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.inventoryItems.get * @memberOf! () * @@ -18358,6 +24211,67 @@ export namespace dfareporting_v3_1 { /** * dfareporting.inventoryItems.list * @desc Retrieves a list of inventory items, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Project ID for order documents. + * projectId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var inventoryItemsPage = response['inventoryItems']; + * if (!inventoryItemsPage) { + * return; + * } + * for (var i = 0; i < inventoryItemsPage.length; i++) { + * // TODO: Change code below to process each resource in `inventoryItemsPage`: + * console.log(JSON.stringify(inventoryItemsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.inventoryItems.list(request, handlePage); + * } + * }; + * + * dfareporting.inventoryItems.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.inventoryItems.list * @memberOf! () * @@ -18529,6 +24443,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.languages.list * @desc Retrieves a list of languages. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.languages.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.languages.list * @memberOf! () * @@ -18622,6 +24581,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.metros.list * @desc Retrieves a list of metros. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.metros.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.metros.list * @memberOf! () * @@ -18713,6 +24717,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.mobileApps.get * @desc Gets one mobile app by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Mobile app ID. + * id: 'my-id', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.mobileApps.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.mobileApps.get * @memberOf! () * @@ -18787,6 +24839,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.mobileApps.list * @desc Retrieves list of available mobile apps. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var mobileAppsPage = response['mobileApps']; + * if (!mobileAppsPage) { + * return; + * } + * for (var i = 0; i < mobileAppsPage.length; i++) { + * // TODO: Change code below to process each resource in `mobileAppsPage`: + * console.log(JSON.stringify(mobileAppsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.mobileApps.list(request, handlePage); + * } + * }; + * + * dfareporting.mobileApps.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.mobileApps.list * @memberOf! () * @@ -18920,6 +25030,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.mobileCarriers.get * @desc Gets one mobile carrier by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Mobile carrier ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.mobileCarriers.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.mobileCarriers.get * @memberOf! () * @@ -18995,10 +25153,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.mobileCarriers.list * @desc Retrieves a list of mobile carriers. - * @alias dfareporting.mobileCarriers.list - * @memberOf! () + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` * - * @param {object} params Parameters for request + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.mobileCarriers.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } + * @alias dfareporting.mobileCarriers.list + * @memberOf! () + * + * @param {object} params Parameters for request * @param {string} params.profileId User profile ID associated with this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -19112,6 +25315,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.operatingSystems.get * @desc Gets one operating system by DART ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Operating system DART ID. + * dartId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.operatingSystems.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.operatingSystems.get * @memberOf! () * @@ -19187,6 +25438,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.operatingSystems.list * @desc Retrieves a list of operating systems. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.operatingSystems.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.operatingSystems.list * @memberOf! () * @@ -19306,6 +25602,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.operatingSystemVersions.get * @desc Gets one operating system version by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Operating system version ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.operatingSystemVersions.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.operatingSystemVersions.get * @memberOf! () * @@ -19383,6 +25727,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.operatingSystemVersions.list * @desc Retrieves a list of operating system versions. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.operatingSystemVersions.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.operatingSystemVersions.list * @memberOf! () * @@ -19504,6 +25893,57 @@ export namespace dfareporting_v3_1 { /** * dfareporting.orderDocuments.get * @desc Gets one order document by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Project ID for order documents. + * projectId: '0', // TODO: Update placeholder value. + * + * // Order document ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.orderDocuments.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.orderDocuments.get * @memberOf! () * @@ -19580,6 +26020,67 @@ export namespace dfareporting_v3_1 { /** * dfareporting.orderDocuments.list * @desc Retrieves a list of order documents, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Project ID for order documents. + * projectId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var orderDocumentsPage = response['orderDocuments']; + * if (!orderDocumentsPage) { + * return; + * } + * for (var i = 0; i < orderDocumentsPage.length; i++) { + * // TODO: Change code below to process each resource in `orderDocumentsPage`: + * console.log(JSON.stringify(orderDocumentsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.orderDocuments.list(request, handlePage); + * } + * }; + * + * dfareporting.orderDocuments.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.orderDocuments.list * @memberOf! () * @@ -19751,6 +26252,57 @@ export namespace dfareporting_v3_1 { /** * dfareporting.orders.get * @desc Gets one order by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Project ID for orders. + * projectId: '0', // TODO: Update placeholder value. + * + * // Order ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.orders.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.orders.get * @memberOf! () * @@ -19824,6 +26376,67 @@ export namespace dfareporting_v3_1 { /** * dfareporting.orders.list * @desc Retrieves a list of orders, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Project ID for orders. + * projectId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var ordersPage = response['orders']; + * if (!ordersPage) { + * return; + * } + * for (var i = 0; i < ordersPage.length; i++) { + * // TODO: Change code below to process each resource in `ordersPage`: + * console.log(JSON.stringify(ordersPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.orders.list(request, handlePage); + * } + * }; + * + * dfareporting.orders.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.orders.list * @memberOf! () * @@ -19975,6 +26588,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placementGroups.get * @desc Gets one placement group by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Placement group ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.placementGroups.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placementGroups.get * @memberOf! () * @@ -20050,6 +26711,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placementGroups.insert * @desc Inserts a new placement group. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.placementGroups.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placementGroups.insert * @memberOf! () * @@ -20125,6 +26835,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placementGroups.list * @desc Retrieves a list of placement groups, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var placementGroupsPage = response['placementGroups']; + * if (!placementGroupsPage) { + * return; + * } + * for (var i = 0; i < placementGroupsPage.length; i++) { + * // TODO: Change code below to process each resource in `placementGroupsPage`: + * console.log(JSON.stringify(placementGroupsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.placementGroups.list(request, handlePage); + * } + * }; + * + * dfareporting.placementGroups.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placementGroups.list * @memberOf! () * @@ -20225,6 +26993,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placementGroups.patch * @desc Updates an existing placement group. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Placement group ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.placementGroups.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placementGroups.patch * @memberOf! () * @@ -20301,6 +27122,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placementGroups.update * @desc Updates an existing placement group. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.placementGroups.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placementGroups.update * @memberOf! () * @@ -20543,6 +27414,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placements.generatetags * @desc Generates tags for a placement. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.placements.generatetags(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placements.generatetags * @memberOf! () * @@ -20629,6 +27545,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placements.get * @desc Gets one placement by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Placement ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.placements.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placements.get * @memberOf! () * @@ -20703,6 +27667,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placements.insert * @desc Inserts a new placement. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.placements.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placements.insert * @memberOf! () * @@ -20777,6 +27790,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placements.list * @desc Retrieves a list of placements, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var placementsPage = response['placements']; + * if (!placementsPage) { + * return; + * } + * for (var i = 0; i < placementsPage.length; i++) { + * // TODO: Change code below to process each resource in `placementsPage`: + * console.log(JSON.stringify(placementsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.placements.list(request, handlePage); + * } + * }; + * + * dfareporting.placements.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placements.list * @memberOf! () * @@ -20873,6 +27944,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placements.patch * @desc Updates an existing placement. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Placement ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.placements.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placements.patch * @memberOf! () * @@ -20947,6 +28071,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placements.update * @desc Updates an existing placement. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.placements.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placements.update * @memberOf! () * @@ -21221,6 +28395,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placementStrategies.delete * @desc Deletes an existing placement strategy. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Placement strategy ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.placementStrategies.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placementStrategies.delete * @memberOf! () * @@ -21294,6 +28513,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placementStrategies.get * @desc Gets one placement strategy by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Placement strategy ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.placementStrategies.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placementStrategies.get * @memberOf! () * @@ -21369,6 +28636,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placementStrategies.insert * @desc Inserts a new placement strategy. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.placementStrategies.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placementStrategies.insert * @memberOf! () * @@ -21444,6 +28760,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placementStrategies.list * @desc Retrieves a list of placement strategies, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var placementStrategiesPage = response['placementStrategies']; + * if (!placementStrategiesPage) { + * return; + * } + * for (var i = 0; i < placementStrategiesPage.length; i++) { + * // TODO: Change code below to process each resource in `placementStrategiesPage`: + * console.log(JSON.stringify(placementStrategiesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.placementStrategies.list(request, handlePage); + * } + * }; + * + * dfareporting.placementStrategies.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placementStrategies.list * @memberOf! () * @@ -21533,6 +28907,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placementStrategies.patch * @desc Updates an existing placement strategy. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Placement strategy ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.placementStrategies.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placementStrategies.patch * @memberOf! () * @@ -21609,6 +29036,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.placementStrategies.update * @desc Updates an existing placement strategy. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.placementStrategies.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.placementStrategies.update * @memberOf! () * @@ -21815,6 +29292,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.platformTypes.get * @desc Gets one platform type by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Platform type ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.platformTypes.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.platformTypes.get * @memberOf! () * @@ -21890,6 +29415,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.platformTypes.list * @desc Retrieves a list of platform types. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.platformTypes.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.platformTypes.list * @memberOf! () * @@ -22007,6 +29577,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.postalCodes.get * @desc Gets one postal code by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Postal code ID. + * code: 'my-code', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.postalCodes.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.postalCodes.get * @memberOf! () * @@ -22081,6 +29699,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.postalCodes.list * @desc Retrieves a list of postal codes. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.postalCodes.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.postalCodes.list * @memberOf! () * @@ -22190,6 +29853,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.projects.get * @desc Gets one project by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Project ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.projects.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.projects.get * @memberOf! () * @@ -22262,6 +29973,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.projects.list * @desc Retrieves a list of projects, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var projectsPage = response['projects']; + * if (!projectsPage) { + * return; + * } + * for (var i = 0; i < projectsPage.length; i++) { + * // TODO: Change code below to process each resource in `projectsPage`: + * console.log(JSON.stringify(projectsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.projects.list(request, handlePage); + * } + * }; + * + * dfareporting.projects.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.projects.list * @memberOf! () * @@ -22405,6 +30174,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.regions.list * @desc Retrieves a list of regions. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.regions.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.regions.list * @memberOf! () * @@ -22496,6 +30310,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.remarketingLists.get * @desc Gets one remarketing list by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Remarketing list ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.remarketingLists.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.remarketingLists.get * @memberOf! () * @@ -22571,6 +30433,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.remarketingLists.insert * @desc Inserts a new remarketing list. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.remarketingLists.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.remarketingLists.insert * @memberOf! () * @@ -22646,6 +30557,67 @@ export namespace dfareporting_v3_1 { /** * dfareporting.remarketingLists.list * @desc Retrieves a list of remarketing lists, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Select only remarketing lists owned by this advertiser. + * advertiserId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var remarketingListsPage = response['remarketingLists']; + * if (!remarketingListsPage) { + * return; + * } + * for (var i = 0; i < remarketingListsPage.length; i++) { + * // TODO: Change code below to process each resource in `remarketingListsPage`: + * console.log(JSON.stringify(remarketingListsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.remarketingLists.list(request, handlePage); + * } + * }; + * + * dfareporting.remarketingLists.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.remarketingLists.list * @memberOf! () * @@ -22737,6 +30709,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.remarketingLists.patch * @desc Updates an existing remarketing list. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Remarketing list ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.remarketingLists.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.remarketingLists.patch * @memberOf! () * @@ -22813,6 +30838,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.remarketingLists.update * @desc Updates an existing remarketing list. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.remarketingLists.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.remarketingLists.update * @memberOf! () * @@ -23011,6 +31086,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.remarketingListShares.get * @desc Gets one remarketing list share by remarketing list ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Remarketing list ID. + * remarketingListId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.remarketingListShares.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.remarketingListShares.get * @memberOf! () * @@ -23088,6 +31211,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.remarketingListShares.patch * @desc Updates an existing remarketing list share. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Remarketing list ID. + * remarketingListId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.remarketingListShares.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.remarketingListShares.patch * @memberOf! () * @@ -23166,6 +31342,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.remarketingListShares.update * @desc Updates an existing remarketing list share. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.remarketingListShares.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.remarketingListShares.update * @memberOf! () * @@ -23311,6 +31537,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.reports.delete * @desc Deletes a report by its ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // The DFA user profile ID. + * profileId: '0', // TODO: Update placeholder value. + * + * // The ID of the report. + * reportId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.reports.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfareporting' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.reports.delete * @memberOf! () * @@ -23383,6 +31654,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.reports.get * @desc Retrieves a report by its ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // The DFA user profile ID. + * profileId: '0', // TODO: Update placeholder value. + * + * // The ID of the report. + * reportId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.reports.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfareporting' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.reports.get * @memberOf! () * @@ -23455,6 +31774,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.reports.insert * @desc Creates a report. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // The DFA user profile ID. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.reports.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfareporting' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.reports.insert * @memberOf! () * @@ -23526,6 +31894,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.reports.list * @desc Retrieves list of reports. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // The DFA user profile ID. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var itemsPage = response['items']; + * if (!itemsPage) { + * return; + * } + * for (var i = 0; i < itemsPage.length; i++) { + * // TODO: Change code below to process each resource in `itemsPage`: + * console.log(JSON.stringify(itemsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.reports.list(request, handlePage); + * } + * }; + * + * dfareporting.reports.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfareporting' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.reports.list * @memberOf! () * @@ -23603,6 +32029,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.reports.patch * @desc Updates a report. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // The DFA user profile ID. + * profileId: '0', // TODO: Update placeholder value. + * + * // The ID of the report. + * reportId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.reports.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfareporting' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.reports.patch * @memberOf! () * @@ -23676,6 +32155,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.reports.run * @desc Runs a report. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // The DFA profile ID. + * profileId: '0', // TODO: Update placeholder value. + * + * // The ID of the report. + * reportId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.reports.run(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfareporting' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.reports.run * @memberOf! () * @@ -23749,6 +32276,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.reports.update * @desc Updates a report. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // The DFA user profile ID. + * profileId: '0', // TODO: Update placeholder value. + * + * // The ID of the report. + * reportId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.reports.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfareporting' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.reports.update * @memberOf! () * @@ -23966,6 +32546,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.reports.compatibleFields.query * @desc Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // The DFA user profile ID. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.reports.compatibleFields.query(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfareporting' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.reports.compatibleFields.query * @memberOf! () * @@ -24066,6 +32695,61 @@ export namespace dfareporting_v3_1 { /** * dfareporting.reports.files.get * @desc Retrieves a report file. This method supports media download. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // The DFA profile ID. + * profileId: '0', // TODO: Update placeholder value. + * + * // The ID of the report. + * reportId: '0', // TODO: Update placeholder value. + * + * // The ID of the report file. + * fileId: '0', // TODO: Update placeholder value. + * + * // TODO: To download media content, use: + * // + * // alt: 'media', + * + * auth: authClient, + * }; + * + * dfareporting.reports.files.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfareporting' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.reports.files.get * @memberOf! () * @@ -24140,6 +32824,67 @@ export namespace dfareporting_v3_1 { /** * dfareporting.reports.files.list * @desc Lists files for a report. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // The DFA profile ID. + * profileId: '0', // TODO: Update placeholder value. + * + * // The ID of the parent report. + * reportId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var itemsPage = response['items']; + * if (!itemsPage) { + * return; + * } + * for (var i = 0; i < itemsPage.length; i++) { + * // TODO: Change code below to process each resource in `itemsPage`: + * console.log(JSON.stringify(itemsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.reports.files.list(request, handlePage); + * } + * }; + * + * dfareporting.reports.files.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfareporting' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.reports.files.list * @memberOf! () * @@ -24277,6 +33022,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.sites.get * @desc Gets one site by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Site ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.sites.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.sites.get * @memberOf! () * @@ -24348,6 +33141,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.sites.insert * @desc Inserts a new site. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.sites.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.sites.insert * @memberOf! () * @@ -24419,6 +33261,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.sites.list * @desc Retrieves a list of sites, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var sitesPage = response['sites']; + * if (!sitesPage) { + * return; + * } + * for (var i = 0; i < sitesPage.length; i++) { + * // TODO: Change code below to process each resource in `sitesPage`: + * console.log(JSON.stringify(sitesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.sites.list(request, handlePage); + * } + * }; + * + * dfareporting.sites.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.sites.list * @memberOf! () * @@ -24506,6 +33406,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.sites.patch * @desc Updates an existing site. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Site ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.sites.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.sites.patch * @memberOf! () * @@ -24578,6 +33531,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.sites.update * @desc Updates an existing site. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.sites.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.sites.update * @memberOf! () * @@ -24795,6 +33798,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.sizes.get * @desc Gets one size by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Size ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.sizes.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.sizes.get * @memberOf! () * @@ -24866,6 +33917,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.sizes.insert * @desc Inserts a new size. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.sizes.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.sizes.insert * @memberOf! () * @@ -24937,6 +34037,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.sizes.list * @desc Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.sizes.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.sizes.list * @memberOf! () * @@ -25079,6 +34224,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.subaccounts.get * @desc Gets one subaccount by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Subaccount ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.subaccounts.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.subaccounts.get * @memberOf! () * @@ -25153,6 +34346,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.subaccounts.insert * @desc Inserts a new subaccount. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.subaccounts.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.subaccounts.insert * @memberOf! () * @@ -25228,6 +34470,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.subaccounts.list * @desc Gets a list of subaccounts, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var subaccountsPage = response['subaccounts']; + * if (!subaccountsPage) { + * return; + * } + * for (var i = 0; i < subaccountsPage.length; i++) { + * // TODO: Change code below to process each resource in `subaccountsPage`: + * console.log(JSON.stringify(subaccountsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.subaccounts.list(request, handlePage); + * } + * }; + * + * dfareporting.subaccounts.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.subaccounts.list * @memberOf! () * @@ -25309,6 +34609,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.subaccounts.patch * @desc Updates an existing subaccount. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Subaccount ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.subaccounts.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.subaccounts.patch * @memberOf! () * @@ -25385,6 +34738,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.subaccounts.update * @desc Updates an existing subaccount. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.subaccounts.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.subaccounts.update * @memberOf! () * @@ -25573,6 +34976,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.targetableRemarketingLists.get * @desc Gets one remarketing list by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Remarketing list ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.targetableRemarketingLists.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.targetableRemarketingLists.get * @memberOf! () * @@ -25653,6 +35104,67 @@ export namespace dfareporting_v3_1 { /** * dfareporting.targetableRemarketingLists.list * @desc Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Select only targetable remarketing lists targetable by these advertisers. + * advertiserId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var targetableRemarketingListsPage = response['targetableRemarketingLists']; + * if (!targetableRemarketingListsPage) { + * return; + * } + * for (var i = 0; i < targetableRemarketingListsPage.length; i++) { + * // TODO: Change code below to process each resource in `targetableRemarketingListsPage`: + * console.log(JSON.stringify(targetableRemarketingListsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.targetableRemarketingLists.list(request, handlePage); + * } + * }; + * + * dfareporting.targetableRemarketingLists.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.targetableRemarketingLists.list * @memberOf! () * @@ -25815,6 +35327,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.targetingTemplates.get * @desc Gets one targeting template by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Targeting template ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.targetingTemplates.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.targetingTemplates.get * @memberOf! () * @@ -25890,6 +35450,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.targetingTemplates.insert * @desc Inserts a new targeting template. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.targetingTemplates.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.targetingTemplates.insert * @memberOf! () * @@ -25965,6 +35574,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.targetingTemplates.list * @desc Retrieves a list of targeting templates, optionally filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var targetingTemplatesPage = response['targetingTemplates']; + * if (!targetingTemplatesPage) { + * return; + * } + * for (var i = 0; i < targetingTemplatesPage.length; i++) { + * // TODO: Change code below to process each resource in `targetingTemplatesPage`: + * console.log(JSON.stringify(targetingTemplatesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.targetingTemplates.list(request, handlePage); + * } + * }; + * + * dfareporting.targetingTemplates.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.targetingTemplates.list * @memberOf! () * @@ -26055,6 +35722,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.targetingTemplates.patch * @desc Updates an existing targeting template. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Targeting template ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.targetingTemplates.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.targetingTemplates.patch * @memberOf! () * @@ -26131,6 +35851,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.targetingTemplates.update * @desc Updates an existing targeting template. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.targetingTemplates.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.targetingTemplates.update * @memberOf! () * @@ -26325,6 +36095,52 @@ export namespace dfareporting_v3_1 { /** * dfareporting.userProfiles.get * @desc Gets one user profile by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // The user profile ID. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.userProfiles.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using one of the following scopes: + * // 'https://www.googleapis.com/auth/dfareporting' + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.userProfiles.get * @memberOf! () * @@ -26397,6 +36213,49 @@ export namespace dfareporting_v3_1 { /** * dfareporting.userProfiles.list * @desc Retrieves list of user profiles for a user. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * auth: authClient, + * }; + * + * dfareporting.userProfiles.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using one of the following scopes: + * // 'https://www.googleapis.com/auth/dfareporting' + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.userProfiles.list * @memberOf! () * @@ -26496,6 +36355,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.userRolePermissionGroups.get * @desc Gets one user role permission group by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // User role permission group ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.userRolePermissionGroups.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.userRolePermissionGroups.get * @memberOf! () * @@ -26573,6 +36480,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.userRolePermissionGroups.list * @desc Gets a list of all supported user role permission groups. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.userRolePermissionGroups.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.userRolePermissionGroups.list * @memberOf! () * @@ -26700,6 +36652,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.userRolePermissions.get * @desc Gets one user role permission by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // User role permission ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.userRolePermissions.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.userRolePermissions.get * @memberOf! () * @@ -26775,6 +36775,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.userRolePermissions.list * @desc Gets a list of user role permissions, possibly filtered. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.userRolePermissions.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.userRolePermissions.list * @memberOf! () * @@ -26899,6 +36944,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.userRoles.delete * @desc Deletes an existing user role. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // User role ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.userRoles.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.userRoles.delete * @memberOf! () * @@ -26971,6 +37061,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.userRoles.get * @desc Gets one user role by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // User role ID. + * id: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.userRoles.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.userRoles.get * @memberOf! () * @@ -27043,6 +37181,55 @@ export namespace dfareporting_v3_1 { /** * dfareporting.userRoles.insert * @desc Inserts a new user role. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.userRoles.insert(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.userRoles.insert * @memberOf! () * @@ -27114,6 +37301,64 @@ export namespace dfareporting_v3_1 { /** * dfareporting.userRoles.list * @desc Retrieves a list of user roles, possibly filtered. This method supports paging. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var userRolesPage = response['userRoles']; + * if (!userRolesPage) { + * return; + * } + * for (var i = 0; i < userRolesPage.length; i++) { + * // TODO: Change code below to process each resource in `userRolesPage`: + * console.log(JSON.stringify(userRolesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * dfareporting.userRoles.list(request, handlePage); + * } + * }; + * + * dfareporting.userRoles.list(request, handlePage); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.userRoles.list * @memberOf! () * @@ -27196,6 +37441,59 @@ export namespace dfareporting_v3_1 { /** * dfareporting.userRoles.patch * @desc Updates an existing user role. This method supports patch semantics. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // User role ID. + * id: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.userRoles.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.userRoles.patch * @memberOf! () * @@ -27268,6 +37566,56 @@ export namespace dfareporting_v3_1 { /** * dfareporting.userRoles.update * @desc Updates an existing user role. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * dfareporting.userRoles.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.userRoles.update * @memberOf! () * @@ -27472,6 +37820,54 @@ export namespace dfareporting_v3_1 { /** * dfareporting.videoFormats.get * @desc Gets one video format by ID. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * // Video format ID. + * id: 0, // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.videoFormats.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.videoFormats.get * @memberOf! () * @@ -27546,6 +37942,51 @@ export namespace dfareporting_v3_1 { /** * dfareporting.videoFormats.list * @desc Lists available video formats. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/dfareporting + * // 2. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var dfareporting = google.dfareporting('v3.1'); + * + * authorize(function(authClient) { + * var request = { + * // User profile ID associated with this request. + * profileId: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * dfareporting.videoFormats.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * // TODO: Change placeholder below to generate authentication credentials. See + * // + * // + * // Authorize using the following scope: + * // 'https://www.googleapis.com/auth/dfatrafficking' + * var authClient = null; + * + * if (authClient == null) { + * console.log('authentication failed'); + * return; + * } + * callback(authClient); + * } * @alias dfareporting.videoFormats.list * @memberOf! () * diff --git a/src/apis/dfareporting/v3.3.ts b/src/apis/dfareporting/v3.3.ts index 44934d8ce2d..2c13b4eb0d8 100644 --- a/src/apis/dfareporting/v3.3.ts +++ b/src/apis/dfareporting/v3.3.ts @@ -1481,11 +1481,11 @@ export namespace dfareporting_v3_3 { */ customVariables?: Schema$CustomFloodlightVariable[]; /** - * The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field. + * The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field. */ encryptedUserId?: string; /** - * A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, mobileDeviceId and gclid. This or encryptedUserId or mobileDeviceId or gclid is a required field. + * A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId and gclid. This or encryptedUserId or matchId or mobileDeviceId or gclid is a required field. */ encryptedUserIdCandidates?: string[]; /** @@ -1497,7 +1497,7 @@ export namespace dfareporting_v3_3 { */ floodlightConfigurationId?: string; /** - * The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a required field. + * The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId is a required field. */ gclid?: string; /** @@ -1509,7 +1509,11 @@ export namespace dfareporting_v3_3 { */ limitAdTracking?: boolean; /** - * The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or gclid is a required field. + * The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field. + */ + matchId?: string; + /** + * The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid is a required field. */ mobileDeviceId?: string; /** diff --git a/src/apis/dfareporting/webpack.config.js b/src/apis/dfareporting/webpack.config.js index b03fe1137f2..998b3ad824b 100644 --- a/src/apis/dfareporting/webpack.config.js +++ b/src/apis/dfareporting/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/digitalassetlinks/package.json b/src/apis/digitalassetlinks/package.json index 1e363b2cb5a..b632a1d0e4f 100644 --- a/src/apis/digitalassetlinks/package.json +++ b/src/apis/digitalassetlinks/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/digitalassetlinks/webpack.config.js b/src/apis/digitalassetlinks/webpack.config.js index f51014ac87a..9e3efb4d736 100644 --- a/src/apis/digitalassetlinks/webpack.config.js +++ b/src/apis/digitalassetlinks/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/discovery/package.json b/src/apis/discovery/package.json index 73ffaaf7e07..f0e5540c3da 100644 --- a/src/apis/discovery/package.json +++ b/src/apis/discovery/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/discovery/webpack.config.js b/src/apis/discovery/webpack.config.js index 2065e5aee7e..a8a2df3c1ae 100644 --- a/src/apis/discovery/webpack.config.js +++ b/src/apis/discovery/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/dlp/package.json b/src/apis/dlp/package.json index ca757eb1a5a..31e78158645 100644 --- a/src/apis/dlp/package.json +++ b/src/apis/dlp/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 90d8deef264..21259e90a50 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -129,6 +129,10 @@ export namespace dlp_v2 { * Enable email notification to project owners and editors on job's completion/failure. */ jobNotificationEmails?: Schema$GooglePrivacyDlpV2JobNotificationEmails; + /** + * Publish findings to Cloud Datahub. + */ + publishFindingsToCloudDataCatalog?: Schema$GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog; /** * Publish summary to Cloud Security Command Center (Alpha). */ @@ -782,6 +786,10 @@ export namespace dlp_v2 { * The item to de-identify. Will be treated as text. */ item?: Schema$GooglePrivacyDlpV2ContentItem; + /** + * The geographic location to process de-identification. Reserved for future extensions. + */ + location?: string; } /** * Results of de-identifying a ContentItem. @@ -890,7 +898,7 @@ export namespace dlp_v2 { deltaPresenceEstimationHistogram?: Schema$GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket[]; } /** - * Rule for modifying a CustomInfoType to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom info type. + * Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. */ export interface Schema$GooglePrivacyDlpV2DetectionRule { /** @@ -1626,6 +1634,15 @@ export namespace dlp_v2 { */ outputPath?: Schema$GooglePrivacyDlpV2CloudStoragePath; } + /** + * Summary statistics of a custom dictionary. + */ + export interface Schema$GooglePrivacyDlpV2LargeCustomDictionaryStats { + /** + * Approximate number of distinct phrases in the dictionary. + */ + approxNumPhrases?: string; + } /** * l-diversity metric, used for analysis of reidentification risk. */ @@ -1904,12 +1921,16 @@ export namespace dlp_v2 { */ windowBefore?: number; } + /** + * Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the results of the DlpJob will be applied to the entry for the resource scanned in Cloud Data Catalog. Any labels previously written by another DlpJob will be deleted. InfoType naming patterns are strictly enforced when using this feature. Note that the findings will be persisted in Cloud Data Catalog storage and are governed by Data Catalog service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified and only allowed if all resources being scanned are BigQuery tables. Compatible with: Inspect + */ + export interface Schema$GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog {} /** * Publish the result summary of a DlpJob to the Cloud Security Command Center (CSCC Alpha). This action is only available for projects which are parts of an organization and whitelisted for the alpha Cloud Security Command Center. The action will publish count of finding instances and their info types. The summary of findings will be persisted in CSCC and are governed by CSCC service-specific policy, see https://cloud.google.com/terms/service-terms Only a single instance of this action can be specified. Compatible with: Inspect */ export interface Schema$GooglePrivacyDlpV2PublishSummaryToCscc {} /** - * Publish the results of a DlpJob to a pub sub channel. Compatible with: Inspect, Risk + * Publish a message into given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk */ export interface Schema$GooglePrivacyDlpV2PublishToPubSub { /** @@ -2267,6 +2288,15 @@ export namespace dlp_v2 { */ largeCustomDictionary?: Schema$GooglePrivacyDlpV2LargeCustomDictionaryConfig; } + /** + * Statistics for a StoredInfoType. + */ + export interface Schema$GooglePrivacyDlpV2StoredInfoTypeStats { + /** + * StoredInfoType where findings are defined by a dictionary of phrases. + */ + largeCustomDictionary?: Schema$GooglePrivacyDlpV2LargeCustomDictionaryStats; + } /** * Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. */ @@ -2287,6 +2317,10 @@ export namespace dlp_v2 { * Stored info type version state. Read-only, updated by the system during dictionary creation. */ state?: string; + /** + * Statistics about this storedInfoType version. + */ + stats?: Schema$GooglePrivacyDlpV2StoredInfoTypeStats; } /** * A reference to a StoredInfoType to use with scanning. @@ -2545,7 +2579,7 @@ export namespace dlp_v2 { */ export interface Schema$GoogleProtobufEmpty {} /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$GoogleRpcStatus { /** @@ -4285,6 +4319,7 @@ export namespace dlp_v2 { image: Resource$Projects$Image; inspectTemplates: Resource$Projects$Inspecttemplates; jobTriggers: Resource$Projects$Jobtriggers; + locations: Resource$Projects$Locations; storedInfoTypes: Resource$Projects$Storedinfotypes; constructor(context: APIRequestContext) { this.context = context; @@ -4298,6 +4333,7 @@ export namespace dlp_v2 { this.context ); this.jobTriggers = new Resource$Projects$Jobtriggers(this.context); + this.locations = new Resource$Projects$Locations(this.context); this.storedInfoTypes = new Resource$Projects$Storedinfotypes( this.context ); @@ -5494,7 +5530,7 @@ export namespace dlp_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of ` `. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) The length of this field should be no more than 500 characters. + * @param {string=} params.filter Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of ` `. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. * @param {string=} params.orderBy Optional comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state` * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. @@ -5650,7 +5686,7 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of ` `. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) The length of this field should be no more than 500 characters. + * Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of ` `. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. */ filter?: string; /** @@ -6907,6 +6943,144 @@ export namespace dlp_v2 { requestBody?: Schema$GooglePrivacyDlpV2UpdateJobTriggerRequest; } + export class Resource$Projects$Locations { + context: APIRequestContext; + content: Resource$Projects$Locations$Content; + constructor(context: APIRequestContext) { + this.context = context; + this.content = new Resource$Projects$Locations$Content(this.context); + } + } + + export class Resource$Projects$Locations$Content { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dlp.projects.locations.content.deidentify + * @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. 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.locations.content.deidentify + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.location The geographic location to process de-identification. Reserved for future extensions. + * @param {string} params.parent The parent resource name, for example projects/my-project-id. + * @param {().GooglePrivacyDlpV2DeidentifyContentRequest} 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 + */ + deidentify( + params?: Params$Resource$Projects$Locations$Content$Deidentify, + options?: MethodOptions + ): GaxiosPromise; + deidentify( + params: Params$Resource$Projects$Locations$Content$Deidentify, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GooglePrivacyDlpV2DeidentifyContentResponse + >, + callback: BodyResponseCallback< + Schema$GooglePrivacyDlpV2DeidentifyContentResponse + > + ): void; + deidentify( + params: Params$Resource$Projects$Locations$Content$Deidentify, + callback: BodyResponseCallback< + Schema$GooglePrivacyDlpV2DeidentifyContentResponse + > + ): void; + deidentify( + callback: BodyResponseCallback< + Schema$GooglePrivacyDlpV2DeidentifyContentResponse + > + ): void; + deidentify( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Content$Deidentify + | BodyResponseCallback< + Schema$GooglePrivacyDlpV2DeidentifyContentResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GooglePrivacyDlpV2DeidentifyContentResponse + >, + callback?: BodyResponseCallback< + Schema$GooglePrivacyDlpV2DeidentifyContentResponse + > + ): void | GaxiosPromise< + Schema$GooglePrivacyDlpV2DeidentifyContentResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Content$Deidentify; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Content$Deidentify; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dlp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2/{+parent}/locations/{location}/content:deidentify' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent', 'location'], + pathParams: ['location', 'parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$GooglePrivacyDlpV2DeidentifyContentResponse + >(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Content$Deidentify + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The geographic location to process de-identification. Reserved for future extensions. + */ + location?: string; + /** + * The parent resource name, for example projects/my-project-id. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GooglePrivacyDlpV2DeidentifyContentRequest; + } + export class Resource$Projects$Storedinfotypes { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/dlp/webpack.config.js b/src/apis/dlp/webpack.config.js index 886a74843d0..b15d1f32934 100644 --- a/src/apis/dlp/webpack.config.js +++ b/src/apis/dlp/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/dns/package.json b/src/apis/dns/package.json index d5ea474b039..84c35f35a2d 100644 --- a/src/apis/dns/package.json +++ b/src/apis/dns/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/dns/v1.ts b/src/apis/dns/v1.ts index 4b948c25a19..fc8b226af7f 100644 --- a/src/apis/dns/v1.ts +++ b/src/apis/dns/v1.ts @@ -317,7 +317,7 @@ export namespace dns_v1 { } export interface Schema$ManagedZoneDnsSecConfig { /** - * Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF. + * Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Can only be changed while state is OFF. */ defaultKeySpecs?: Schema$DnsKeySpec[]; /** @@ -325,7 +325,7 @@ export namespace dns_v1 { */ kind?: string; /** - * Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF. + * Specifies the mechanism used to provide authenticated denial-of-existence responses. Can only be changed while state is OFF. */ nonExistence?: string; /** @@ -677,7 +677,7 @@ export namespace dns_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -807,7 +807,7 @@ export namespace dns_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -951,7 +951,7 @@ export namespace dns_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1112,7 +1112,7 @@ export namespace dns_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1189,7 +1189,7 @@ export namespace dns_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1328,7 +1328,7 @@ export namespace dns_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1410,7 +1410,7 @@ export namespace dns_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1605,7 +1605,7 @@ export namespace dns_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1729,7 +1729,7 @@ export namespace dns_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1856,7 +1856,7 @@ export namespace dns_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1997,7 +1997,7 @@ export namespace dns_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2074,7 +2074,7 @@ export namespace dns_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2150,7 +2150,7 @@ export namespace dns_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2413,7 +2413,7 @@ export namespace dns_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2585,7 +2585,7 @@ export namespace dns_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { diff --git a/src/apis/dns/v1beta2.ts b/src/apis/dns/v1beta2.ts index 7917c61470c..4003185b4b0 100644 --- a/src/apis/dns/v1beta2.ts +++ b/src/apis/dns/v1beta2.ts @@ -327,7 +327,7 @@ export namespace dns_v1beta2 { } export interface Schema$ManagedZoneDnsSecConfig { /** - * Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF. + * Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Can only be changed while state is OFF. */ defaultKeySpecs?: Schema$DnsKeySpec[]; /** @@ -335,7 +335,7 @@ export namespace dns_v1beta2 { */ kind?: string; /** - * Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF. + * Specifies the mechanism used to provide authenticated denial-of-existence responses. Can only be changed while state is OFF. */ nonExistence?: string; /** @@ -390,7 +390,7 @@ export namespace dns_v1beta2 { } export interface Schema$ManagedZonePeeringConfigTargetNetwork { /** - * If this zone has been deactivated due to a problem with the network it targeted, the time at which it was deactivated. The zone can be deactivated if, for instance, the network it targeted was deleted. If the targeted network is still present, this will be the empty string. This is in RFC3339 text format. Output only. + * If this zone has been deactivated (possibly because the producer network it targeted was deleted), the time at which it was deactivated. If the peering connection is still active, this will be the empty string. This is in RFC3339 text format. Output only. */ deactivateTime?: string; /** @@ -780,7 +780,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -854,7 +854,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -932,7 +932,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1093,7 +1093,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1170,7 +1170,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1309,7 +1309,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1391,7 +1391,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1532,7 +1532,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1605,7 +1605,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1680,7 +1680,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1759,7 +1759,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1835,7 +1835,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1912,7 +1912,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2127,7 +2127,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2200,7 +2200,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2272,7 +2272,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2348,7 +2348,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2426,7 +2426,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2503,7 +2503,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2707,7 +2707,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2813,7 +2813,7 @@ export namespace dns_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://dns.googleapis.com/'; const parameters = { options: Object.assign( { diff --git a/src/apis/dns/v2beta1.ts b/src/apis/dns/v2beta1.ts index b681d2ae397..a1e546e9273 100644 --- a/src/apis/dns/v2beta1.ts +++ b/src/apis/dns/v2beta1.ts @@ -317,7 +317,7 @@ export namespace dns_v2beta1 { } export interface Schema$ManagedZoneDnsSecConfig { /** - * Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Output only while state is not OFF. + * Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. Can only be changed while state is OFF. */ defaultKeySpecs?: Schema$DnsKeySpec[]; /** @@ -325,7 +325,7 @@ export namespace dns_v2beta1 { */ kind?: string; /** - * Specifies the mechanism used to provide authenticated denial-of-existence responses. Output only while state is not OFF. + * Specifies the mechanism used to provide authenticated denial-of-existence responses. Can only be changed while state is OFF. */ nonExistence?: string; /** @@ -588,7 +588,7 @@ export namespace dns_v2beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dns = google.dns('v2beta1'); * * authorize(function(authClient) { @@ -618,16 +618,12 @@ export namespace dns_v2beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dns.changes.create @@ -719,7 +715,7 @@ export namespace dns_v2beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dns = google.dns('v2beta1'); * * authorize(function(authClient) { @@ -748,16 +744,12 @@ export namespace dns_v2beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dns.changes.get @@ -849,7 +841,7 @@ export namespace dns_v2beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dns = google.dns('v2beta1'); * * authorize(function(authClient) { @@ -888,16 +880,12 @@ export namespace dns_v2beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dns.changes.list @@ -1079,7 +1067,7 @@ export namespace dns_v2beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dns = google.dns('v2beta1'); * * authorize(function(authClient) { @@ -1108,16 +1096,12 @@ export namespace dns_v2beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dns.dnsKeys.get @@ -1210,7 +1194,7 @@ export namespace dns_v2beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dns = google.dns('v2beta1'); * * authorize(function(authClient) { @@ -1249,16 +1233,12 @@ export namespace dns_v2beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dns.dnsKeys.list @@ -1415,7 +1395,7 @@ export namespace dns_v2beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dns = google.dns('v2beta1'); * * authorize(function(authClient) { @@ -1444,16 +1424,12 @@ export namespace dns_v2beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dns.managedZoneOperations.get @@ -1548,7 +1524,7 @@ export namespace dns_v2beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dns = google.dns('v2beta1'); * * authorize(function(authClient) { @@ -1587,16 +1563,12 @@ export namespace dns_v2beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dns.managedZoneOperations.list @@ -1761,7 +1733,7 @@ export namespace dns_v2beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dns = google.dns('v2beta1'); * * authorize(function(authClient) { @@ -1788,16 +1760,12 @@ export namespace dns_v2beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dns.managedZones.create @@ -1890,7 +1858,7 @@ export namespace dns_v2beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dns = google.dns('v2beta1'); * * authorize(function(authClient) { @@ -1904,28 +1872,21 @@ export namespace dns_v2beta1 { * auth: authClient, * }; * - * dns.managedZones.delete(request, function(err, response) { + * dns.managedZones.delete(request, function(err) { * if (err) { * console.error(err); * return; * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); * }); * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dns.managedZones.delete @@ -2017,7 +1978,7 @@ export namespace dns_v2beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dns = google.dns('v2beta1'); * * authorize(function(authClient) { @@ -2043,16 +2004,12 @@ export namespace dns_v2beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dns.managedZones.get @@ -2145,7 +2102,7 @@ export namespace dns_v2beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dns = google.dns('v2beta1'); * * authorize(function(authClient) { @@ -2181,16 +2138,12 @@ export namespace dns_v2beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dns.managedZones.list @@ -2286,7 +2239,7 @@ export namespace dns_v2beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dns = google.dns('v2beta1'); * * authorize(function(authClient) { @@ -2317,16 +2270,12 @@ export namespace dns_v2beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dns.managedZones.patch @@ -2421,7 +2370,7 @@ export namespace dns_v2beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dns = google.dns('v2beta1'); * * authorize(function(authClient) { @@ -2452,16 +2401,12 @@ export namespace dns_v2beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dns.managedZones.update @@ -2698,7 +2643,7 @@ export namespace dns_v2beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dns = google.dns('v2beta1'); * * authorize(function(authClient) { @@ -2721,16 +2666,12 @@ export namespace dns_v2beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dns.projects.get @@ -2843,7 +2784,7 @@ export namespace dns_v2beta1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var dns = google.dns('v2beta1'); * * authorize(function(authClient) { @@ -2882,16 +2823,12 @@ export namespace dns_v2beta1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias dns.resourceRecordSets.list diff --git a/src/apis/dns/webpack.config.js b/src/apis/dns/webpack.config.js index 3c41aae0a65..6ccdb7bad57 100644 --- a/src/apis/dns/webpack.config.js +++ b/src/apis/dns/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/docs/package.json b/src/apis/docs/package.json index fc3658424f4..b60d3c8f6c5 100644 --- a/src/apis/docs/package.json +++ b/src/apis/docs/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/docs/v1.ts b/src/apis/docs/v1.ts index ceada3521ce..f72a44bbb56 100644 --- a/src/apis/docs/v1.ts +++ b/src/apis/docs/v1.ts @@ -424,65 +424,65 @@ export namespace docs_v1 { */ export interface Schema$Document { /** - * The main body of the document. + * Output only. The main body of the document. */ body?: Schema$Body; /** - * The ID of the document. + * Output only. The ID of the document. */ documentId?: string; /** - * The style of the document. + * Output only. The style of the document. */ documentStyle?: Schema$DocumentStyle; /** - * The footers in the document, keyed by footer ID. + * Output only. The footers in the document, keyed by footer ID. */ footers?: {[key: string]: Schema$Footer}; /** - * The footnotes in the document, keyed by footnote ID. + * Output only. The footnotes in the document, keyed by footnote ID. */ footnotes?: {[key: string]: Schema$Footnote}; /** - * The headers in the document, keyed by header ID. + * Output only. The headers in the document, keyed by header ID. */ headers?: {[key: string]: Schema$Header}; /** - * The inline objects in the document, keyed by object ID. + * Output only. The inline objects in the document, keyed by object ID. */ inlineObjects?: {[key: string]: Schema$InlineObject}; /** - * The lists in the document, keyed by list ID. + * Output only. The lists in the document, keyed by list ID. */ lists?: {[key: string]: Schema$List}; /** - * The named ranges in the document, keyed by name. + * Output only. The named ranges in the document, keyed by name. */ namedRanges?: {[key: string]: Schema$NamedRanges}; /** - * The named styles of the document. + * Output only. The named styles of the document. */ namedStyles?: Schema$NamedStyles; /** - * The positioned objects in the document, keyed by object ID. + * Output only. The positioned objects in the document, keyed by object ID. */ positionedObjects?: {[key: string]: Schema$PositionedObject}; /** - * The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated; however, a changed ID can also be due to internal factors such as ID format changes. + * Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated; however, a changed ID can also be due to internal factors such as ID format changes. */ revisionId?: string; /** - * The suggested changes to the style of the document, keyed by suggestion ID. + * Output only. The suggested changes to the style of the document, keyed by suggestion ID. */ suggestedDocumentStyleChanges?: { [key: string]: Schema$SuggestedDocumentStyle; }; /** - * The suggested changes to the named styles of the document, keyed by suggestion ID. + * Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. */ suggestedNamedStylesChanges?: {[key: string]: Schema$SuggestedNamedStyles}; /** - * The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. + * Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. */ suggestionsViewMode?: string; /** @@ -669,7 +669,7 @@ export namespace docs_v1 { */ marginTop?: Schema$Dimension; /** - * The size of the embedded object. + * The visible size of the image after cropping. */ size?: Schema$Size; /** @@ -900,7 +900,7 @@ export namespace docs_v1 { */ contrast?: number; /** - * The crop properties of the image. After cropping, the image will be stretched to fit in its container. + * The crop properties of the image. */ cropProperties?: Schema$CropProperties; /** @@ -2289,11 +2289,11 @@ export namespace docs_v1 { tableCellStyle?: Schema$TableCellStyle; } /** - * A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. + * A border around a table cell. */ export interface Schema$TableCellBorder { /** - * The color of the border. This color cannot be transparent. + * The color of the border. */ color?: Schema$OptionalColor; /** diff --git a/src/apis/docs/webpack.config.js b/src/apis/docs/webpack.config.js index 1e718cf9ab9..29de35aab7e 100644 --- a/src/apis/docs/webpack.config.js +++ b/src/apis/docs/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/doubleclickbidmanager/package.json b/src/apis/doubleclickbidmanager/package.json index 80fadc8fe28..80e8c7fde38 100644 --- a/src/apis/doubleclickbidmanager/package.json +++ b/src/apis/doubleclickbidmanager/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/doubleclickbidmanager/webpack.config.js b/src/apis/doubleclickbidmanager/webpack.config.js index bf5bb2a8290..bbb77b2837e 100644 --- a/src/apis/doubleclickbidmanager/webpack.config.js +++ b/src/apis/doubleclickbidmanager/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/doubleclicksearch/package.json b/src/apis/doubleclicksearch/package.json index 769820143ad..534f0bff6c2 100644 --- a/src/apis/doubleclicksearch/package.json +++ b/src/apis/doubleclicksearch/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/doubleclicksearch/webpack.config.js b/src/apis/doubleclicksearch/webpack.config.js index 743c21bf244..57c11b5437a 100644 --- a/src/apis/doubleclicksearch/webpack.config.js +++ b/src/apis/doubleclicksearch/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/drive/package.json b/src/apis/drive/package.json index da87e5c5b1d..0b41a056572 100644 --- a/src/apis/drive/package.json +++ b/src/apis/drive/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index 4f5494fa138..26ade0ffe5b 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -494,7 +494,7 @@ export namespace drive_v2 { */ id?: string; /** - * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". + * Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". */ kind?: string; /** @@ -4404,7 +4404,7 @@ export namespace drive_v2 { /** * drive.files.generateIds - * @desc Generates a set of file IDs which can be provided in insert requests. + * @desc Generates a set of file IDs which can be provided in insert or copy requests. * @alias drive.files.generateIds * @memberOf! () * diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index 88849b9b852..db3964d4101 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -276,7 +276,7 @@ export namespace drive_v3 { */ id?: string; /** - * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". + * Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". */ kind?: string; /** @@ -3165,7 +3165,7 @@ export namespace drive_v3 { /** * drive.files.generateIds - * @desc Generates a set of file IDs which can be provided in create requests. + * @desc Generates a set of file IDs which can be provided in create or copy requests. * @alias drive.files.generateIds * @memberOf! () * diff --git a/src/apis/drive/webpack.config.js b/src/apis/drive/webpack.config.js index ce87023b8bf..4bb56f36e49 100644 --- a/src/apis/drive/webpack.config.js +++ b/src/apis/drive/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/driveactivity/package.json b/src/apis/driveactivity/package.json index 3793934af1d..1c0fdccf33d 100644 --- a/src/apis/driveactivity/package.json +++ b/src/apis/driveactivity/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/driveactivity/webpack.config.js b/src/apis/driveactivity/webpack.config.js index d80f22faef7..7c2e419a33f 100644 --- a/src/apis/driveactivity/webpack.config.js +++ b/src/apis/driveactivity/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/factchecktools/package.json b/src/apis/factchecktools/package.json index 1032b09adea..dbad170364c 100644 --- a/src/apis/factchecktools/package.json +++ b/src/apis/factchecktools/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/factchecktools/webpack.config.js b/src/apis/factchecktools/webpack.config.js index 78053a70294..5c0ebe0449a 100644 --- a/src/apis/factchecktools/webpack.config.js +++ b/src/apis/factchecktools/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/fcm/README.md b/src/apis/fcm/README.md new file mode 100644 index 00000000000..9ded2f0c5a1 --- /dev/null +++ b/src/apis/fcm/README.md @@ -0,0 +1,47 @@ +Google Inc. logo + +# fcm + +> FCM send API that provides a cross-platform messaging solution to reliably deliver messages at no cost. + +## Installation + +```sh +$ npm install googleapis +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). + +## Building a browser bundle + +This library can be used in a browser. To prepare a single file bundle, clone the +[repository](https://github.com/googleapis/google-api-nodejs-client) and run + +```sh +$ cd src/apis/fcm +$ npm install +$ npm run webpack +``` + +The generated bundle will be written to `dist/fcm.min.js`. Use it from your HTML file: + +```html + + +``` + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/master/LICENSE). + +## 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/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/fcm/index.ts b/src/apis/fcm/index.ts new file mode 100644 index 00000000000..ef580bb0155 --- /dev/null +++ b/src/apis/fcm/index.ts @@ -0,0 +1,33 @@ +// Copyright 2019 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 {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {fcm_v1} from './v1'; + +export const VERSIONS = { + v1: fcm_v1.Fcm, +}; + +export function fcm(version: 'v1'): fcm_v1.Fcm; +export function fcm(options: fcm_v1.Options): fcm_v1.Fcm; +export function fcm( + this: GoogleConfigurable, + versionOrOptions: 'v1' | fcm_v1.Options +) { + return getAPI('fcm', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; diff --git a/src/apis/fcm/package.json b/src/apis/fcm/package.json new file mode 100644 index 00000000000..9dc19a53e94 --- /dev/null +++ b/src/apis/fcm/package.json @@ -0,0 +1,43 @@ +{ + "name": "@google/fcm", + "version": "0.1.0", + "description": "fcm", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=8.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "docs": "typedoc --out docs/", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^2.0.4" + }, + "devDependencies": { + "gts": "^1.0.0", + "null-loader": "^3.0.0", + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" + } +} diff --git a/src/apis/fcm/tsconfig.json b/src/apis/fcm/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/fcm/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/fcm/v1.ts b/src/apis/fcm/v1.ts new file mode 100644 index 00000000000..bb254b4454b --- /dev/null +++ b/src/apis/fcm/v1.ts @@ -0,0 +1,458 @@ +/** + * Copyright 2019 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. + */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace fcm_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Firebase Cloud Messaging API + * + * FCM send API that provides a cross-platform messaging solution to reliably deliver messages at no cost. + * + * @example + * const {google} = require('googleapis'); + * const fcm = google.fcm('v1'); + * + * @namespace fcm + * @type {Function} + * @version v1 + * @variation v1 + * @param {object=} options Options for Fcm + */ + export class Fcm { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * Android specific options for messages sent through [FCM connection server](https://goo.gl/4GLdUl). + */ + export interface Schema$AndroidConfig { + /** + * An identifier of a group of messages that can be collapsed, so that only the last message gets sent when delivery can be resumed. A maximum of 4 different collapse keys is allowed at any given time. + */ + collapseKey?: string; + /** + * Arbitrary key/value payload. If present, it will override google.firebase.fcm.v1.Message.data. + */ + data?: {[key: string]: string}; + /** + * Options for features provided by the FCM SDK for Android. + */ + fcmOptions?: Schema$AndroidFcmOptions; + /** + * Notification to send to android devices. + */ + notification?: Schema$AndroidNotification; + /** + * Message priority. Can take "normal" and "high" values. For more information, see [Setting the priority of a message](https://goo.gl/GjONJv). + */ + priority?: string; + /** + * Package name of the application where the registration token must match in order to receive the message. + */ + restrictedPackageName?: string; + /** + * How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks if not set. Set it to 0 if want to send the message immediately. In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s". The ttl will be rounded down to the nearest second. + */ + ttl?: string; + } + /** + * Options for features provided by the FCM SDK for Android. + */ + export interface Schema$AndroidFcmOptions { + /** + * Label associated with the message's analytics data. + */ + analyticsLabel?: string; + } + /** + * Notification to send to android devices. + */ + export interface Schema$AndroidNotification { + /** + * The notification's body text. If present, it will override google.firebase.fcm.v1.Notification.body. + */ + body?: string; + /** + * Variable string values to be used in place of the format specifiers in body_loc_key to use to localize the body text to the user's current localization. See [Formatting and Styling](https://goo.gl/MalYE3) for more information. + */ + bodyLocArgs?: string[]; + /** + * The key to the body string in the app's string resources to use to localize the body text to the user's current localization. See [String Resources](https://goo.gl/NdFZGI) for more information. + */ + bodyLocKey?: string; + /** + * The [notification's channel id](https://developer.android.com/guide/topics/ui/notifiers/notifications#ManageChannels) (new in Android O). The app must create a channel with this channel ID before any notification with this channel ID is received. If you don't send this channel ID in the request, or if the channel ID provided has not yet been created by the app, FCM uses the channel ID specified in the app manifest. + */ + channelId?: string; + /** + * The action associated with a user click on the notification. If specified, an activity with a matching intent filter is launched when a user clicks on the notification. + */ + clickAction?: string; + /** + * The notification's icon color, expressed in #rrggbb format. + */ + color?: string; + /** + * The notification's icon. Sets the notification icon to myicon for drawable resource myicon. If you don't send this key in the request, FCM displays the launcher icon specified in your app manifest. + */ + icon?: string; + /** + * The sound to play when the device receives the notification. Supports "default" or the filename of a sound resource bundled in the app. Sound files must reside in /res/raw/. + */ + sound?: string; + /** + * Identifier used to replace existing notifications in the notification drawer. If not specified, each request creates a new notification. If specified and a notification with the same tag is already being shown, the new notification replaces the existing one in the notification drawer. + */ + tag?: string; + /** + * The notification's title. If present, it will override google.firebase.fcm.v1.Notification.title. + */ + title?: string; + /** + * Variable string values to be used in place of the format specifiers in title_loc_key to use to localize the title text to the user's current localization. See [Formatting and Styling](https://goo.gl/MalYE3) for more information. + */ + titleLocArgs?: string[]; + /** + * The key to the title string in the app's string resources to use to localize the title text to the user's current localization. See [String Resources](https://goo.gl/NdFZGI) for more information. + */ + titleLocKey?: string; + } + /** + * [Apple Push Notification Service](https://goo.gl/MXRTPa) specific options. + */ + export interface Schema$ApnsConfig { + /** + * Options for features provided by the FCM SDK for iOS. + */ + fcmOptions?: Schema$ApnsFcmOptions; + /** + * HTTP request headers defined in Apple Push Notification Service. Refer to [APNs request headers](https://goo.gl/C6Yhia) for supported headers, e.g. "apns-priority": "10". + */ + headers?: {[key: string]: string}; + /** + * APNs payload as a JSON object, including both `aps` dictionary and custom payload. See [Payload Key Reference](https://goo.gl/32Pl5W). If present, it overrides google.firebase.fcm.v1.Notification.title and google.firebase.fcm.v1.Notification.body. + */ + payload?: {[key: string]: any}; + } + /** + * Options for features provided by the FCM SDK for iOS. + */ + export interface Schema$ApnsFcmOptions { + /** + * Label associated with the message's analytics data. + */ + analyticsLabel?: string; + } + /** + * Platform independent options for features provided by the FCM SDKs. + */ + export interface Schema$FcmOptions { + /** + * Label associated with the message's analytics data. + */ + analyticsLabel?: string; + } + /** + * Message to send by Firebase Cloud Messaging Service. + */ + export interface Schema$Message { + /** + * Input only. Android specific options for messages sent through [FCM connection server](https://goo.gl/4GLdUl). + */ + android?: Schema$AndroidConfig; + /** + * Input only. [Apple Push Notification Service](https://goo.gl/MXRTPa) specific options. + */ + apns?: Schema$ApnsConfig; + /** + * Condition to send a message to, e.g. "'foo' in topics && 'bar' in topics". + */ + condition?: string; + /** + * Input only. Arbitrary key/value payload. + */ + data?: {[key: string]: string}; + /** + * Input only. Template for FCM SDK feature options to use across all platforms. + */ + fcmOptions?: Schema$FcmOptions; + /** + * Output Only. The identifier of the message sent, in the format of `projects/x/messages/{message_id}`. + */ + name?: string; + /** + * Input only. Basic notification template to use across all platforms. + */ + notification?: Schema$Notification; + /** + * Registration token to send a message to. + */ + token?: string; + /** + * Topic name to send a message to, e.g. "weather". Note: "/topics/" prefix should not be provided. + */ + topic?: string; + /** + * Input only. [Webpush protocol](https://tools.ietf.org/html/rfc8030) options. + */ + webpush?: Schema$WebpushConfig; + } + /** + * Basic notification template to use across all platforms. + */ + export interface Schema$Notification { + /** + * The notification's body text. + */ + body?: string; + /** + * The notification's title. + */ + title?: string; + } + /** + * Request to send a message to specified target. + */ + export interface Schema$SendMessageRequest { + /** + * Required. Message to send. + */ + message?: Schema$Message; + /** + * Flag for testing the request without actually delivering the message. + */ + validateOnly?: boolean; + } + /** + * [Webpush protocol](https://tools.ietf.org/html/rfc8030) options. + */ + export interface Schema$WebpushConfig { + /** + * Arbitrary key/value payload. If present, it will override google.firebase.fcm.v1.Message.data. + */ + data?: {[key: string]: string}; + /** + * Options for features provided by the FCM SDK for Web. + */ + fcmOptions?: Schema$WebpushFcmOptions; + /** + * HTTP headers defined in webpush protocol. Refer to [Webpush protocol](https://tools.ietf.org/html/rfc8030#section-5) for supported headers, e.g. "TTL": "15". + */ + headers?: {[key: string]: string}; + /** + * Web Notification options as a JSON object. Supports Notification instance properties as defined in [Web Notification API](https://developer.mozilla.org/en-US/docs/Web/API/Notification). If present, "title" and "body" fields override [google.firebase.fcm.v1.Notification.title] and [google.firebase.fcm.v1.Notification.body]. + */ + notification?: {[key: string]: any}; + } + /** + * Options for features provided by the FCM SDK for Web. + */ + export interface Schema$WebpushFcmOptions { + /** + * The link to open when the user clicks on the notification. For all URL values, HTTPS is required. + */ + link?: string; + } + + export class Resource$Projects { + context: APIRequestContext; + messages: Resource$Projects$Messages; + constructor(context: APIRequestContext) { + this.context = context; + this.messages = new Resource$Projects$Messages(this.context); + } + } + + export class Resource$Projects$Messages { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * fcm.projects.messages.send + * @desc Send a message to specified target (a registration token, topic or condition). + * @alias fcm.projects.messages.send + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. It contains the Firebase project id (i.e. the unique identifier for your Firebase project), in the format of `projects/{project_id}`. For legacy support, the numeric project number with no padding is also supported in the format of `projects/{project_number}`. + * @param {().SendMessageRequest} 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 + */ + send( + params?: Params$Resource$Projects$Messages$Send, + options?: MethodOptions + ): GaxiosPromise; + send( + params: Params$Resource$Projects$Messages$Send, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + send( + params: Params$Resource$Projects$Messages$Send, + callback: BodyResponseCallback + ): void; + send(callback: BodyResponseCallback): void; + send( + paramsOrCallback?: + | Params$Resource$Projects$Messages$Send + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Messages$Send; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Messages$Send; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://fcm.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/messages:send').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Messages$Send + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. It contains the Firebase project id (i.e. the unique identifier for your Firebase project), in the format of `projects/{project_id}`. For legacy support, the numeric project number with no padding is also supported in the format of `projects/{project_number}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SendMessageRequest; + } +} diff --git a/src/apis/fcm/webpack.config.js b/src/apis/fcm/webpack.config.js new file mode 100644 index 00000000000..0e5a5ee211e --- /dev/null +++ b/src/apis/fcm/webpack.config.js @@ -0,0 +1,71 @@ +/** + * Copyright 2019 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. + */ + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + }, + output: { + library: 'Fcm', + filename: 'fcm.min.js', + path: path.resolve(__dirname, 'dist'), + }, + node: { + child_process: 'empty', + fs: 'empty', + crypto: 'empty', + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/file/package.json b/src/apis/file/package.json index c3218d0372f..d4886ca8631 100644 --- a/src/apis/file/package.json +++ b/src/apis/file/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index 246dbe93840..12eae7b7c5f 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -139,7 +139,7 @@ export namespace file_v1 { name?: string; } /** - * Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project=snapchat, producer-project=cloud-sql: ```json Instance: { "name": "projects/snapchat/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_version": "cloud-sql-09-28-2018", "maintenance_policy_names": { "UpdatePolicy": "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update-policy", } "rollout_metadata": { "projects/cloud-sql/locations/global/rolloutTypes/software_update": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-28-2018", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-28-2018-canary", } "projects/cloud-sql/locations/global/rolloutTypes/instance_restart": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-20-repair", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-20-repair-100-percent", } } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", } ], } ``` + * Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project=snapchat, producer-project=cloud-sql: ```json Instance: { "name": "projects/snapchat/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", }, "maintenance_policy_names": { "UpdatePolicy": "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update-policy", } "rollout_metadata": { "projects/cloud-sql/locations/global/rolloutTypes/software_update": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-28-2018", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-28-2018-canary", }, "projects/cloud-sql/locations/global/rolloutTypes/instance_restart": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-20-repair", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-20-repair-100-percent", } } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", } ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, }, "ncsa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, } } } ``` */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1Instance { /** @@ -151,9 +151,15 @@ export namespace file_v1 { */ labels?: {[key: string]: string}; /** - * The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to //depot/google3/google/cloud/saasaccelerator/maintenancepolicy/api/v1/maintenance_policy_resources.proto + * The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. */ maintenancePolicyNames?: {[key: string]: string}; + /** + * The MaintenanceSchedule contains the scheduling information of published maintenance schedule. + */ + maintenanceSchedules?: { + [key: string]: Schema$GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule; + }; /** * Unique name of the resource. It uses the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` */ @@ -193,6 +199,40 @@ export namespace file_v1 { */ updateTime?: string; } + /** + * Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule { + /** + * Can this scheduled update be rescheduled? By default, it's true and API needs to do explicitly check whether it's set, if it's set as false explicitly, it's false + */ + canReschedule?: boolean; + /** + * The scheduled end time for the maintenance. + */ + endTime?: string; + /** + * The scheduled start time for the maintenance. + */ + startTime?: string; + } + /** + * Node information for custom per-node SLO implementations. SSA does not support per-node SLO, but producers can populate per-node information in SloMetadata for custom precomputations. SSA Eligibility Exporter will emit per-node metric based on this information. + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata { + /** + * By default node is eligible if instance is eligible. But individual node might be excluded from SLO by adding entry here. For semantic see SloMetadata.exclusions. If both instance and node level exclusions are present for time period, the node level's reason will be reported by Eligibility Exporter. + */ + exclusions?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion[]; + /** + * The location of the node, if different from instance location. + */ + location?: string; + /** + * The id of the node. This should be equal to SaasInstanceNode.node_id. + */ + nodeId?: string; + } /** * NotificationMetadata is the notification state for an instance. */ @@ -245,7 +285,7 @@ export namespace file_v1 { rolloutName?: string; } /** - * A temporal SLO exclusion specification. + * SloExclusion represents an excusion in SLI calculation applies to all SLOs. */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion { /** @@ -261,9 +301,9 @@ export namespace file_v1 { */ reason?: string; /** - * Name of an SLI/SLO that this exclusion applies to. Can be left empty, signaling that the instance should be excluded from all SLI/SLOs defined in the service SLO configuration. + * Name of an SLI that this exclusion applies to. Can be left empty, signaling that the instance should be excluded from all SLIs defined in the service SLO configuration. */ - sloName?: string; + sliName?: string; } /** * SloMetadata contains resources required for proper SLO classification of the instance. @@ -273,6 +313,10 @@ export namespace file_v1 { * List of SLO exclusion windows. When multiple entries in the list match (matching the exclusion time-window against current time point) the exclusion reason used in the first matching entry will be published. It is not needed to include expired exclusion in this list, as only the currently applicable exclusions are taken into account by the eligibility exporting subsystem (the historical state of exclusions will be reflected in the historically produced timeseries regardless of the current state). This field can be used to mark the instance as temporary ineligible for the purpose of SLO calculation. For permanent instance SLO exclusion, a dedicated tier name can be used that does not have targets specified in the service SLO configuration. */ exclusions?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion[]; + /** + * Optional: list of nodes. Some producers need to use per-node metadata to calculate SLO. This field allows such producers to publish per-node SLO meta data, which will be consumed by SSA Eligibility Exporter and published in the form of per node metric to Monarch. + */ + nodes?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata[]; /** * Name of the SLO tier the Instance belongs to. This name will be expected to match the tiers specified in the service SLO configuration. Field is mandatory and must not be empty. */ @@ -429,7 +473,7 @@ export namespace file_v1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -471,7 +515,7 @@ export namespace file_v1 { verb?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index fa96fb05192..98d8b2e86da 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -139,7 +139,7 @@ export namespace file_v1beta1 { name?: string; } /** - * Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project=snapchat, producer-project=cloud-sql: ```json Instance: { "name": "projects/snapchat/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_version": "cloud-sql-09-28-2018", "maintenance_policy_names": { "UpdatePolicy": "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update-policy", } "rollout_metadata": { "projects/cloud-sql/locations/global/rolloutTypes/software_update": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-28-2018", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-28-2018-canary", } "projects/cloud-sql/locations/global/rolloutTypes/instance_restart": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-20-repair", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-20-repair-100-percent", } } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", } ], } ``` + * Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project=snapchat, producer-project=cloud-sql: ```json Instance: { "name": "projects/snapchat/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", }, "maintenance_policy_names": { "UpdatePolicy": "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update-policy", } "rollout_metadata": { "projects/cloud-sql/locations/global/rolloutTypes/software_update": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-28-2018", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-28-2018-canary", }, "projects/cloud-sql/locations/global/rolloutTypes/instance_restart": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-20-repair", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-20-repair-100-percent", } } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", } ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, }, "ncsa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, } } } ``` */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1Instance { /** @@ -151,9 +151,15 @@ export namespace file_v1beta1 { */ labels?: {[key: string]: string}; /** - * The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to //depot/google3/google/cloud/saasaccelerator/maintenancepolicy/api/v1/maintenance_policy_resources.proto + * The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. */ maintenancePolicyNames?: {[key: string]: string}; + /** + * The MaintenanceSchedule contains the scheduling information of published maintenance schedule. + */ + maintenanceSchedules?: { + [key: string]: Schema$GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule; + }; /** * Unique name of the resource. It uses the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` */ @@ -193,6 +199,40 @@ export namespace file_v1beta1 { */ updateTime?: string; } + /** + * Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule { + /** + * Can this scheduled update be rescheduled? By default, it's true and API needs to do explicitly check whether it's set, if it's set as false explicitly, it's false + */ + canReschedule?: boolean; + /** + * The scheduled end time for the maintenance. + */ + endTime?: string; + /** + * The scheduled start time for the maintenance. + */ + startTime?: string; + } + /** + * Node information for custom per-node SLO implementations. SSA does not support per-node SLO, but producers can populate per-node information in SloMetadata for custom precomputations. SSA Eligibility Exporter will emit per-node metric based on this information. + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata { + /** + * By default node is eligible if instance is eligible. But individual node might be excluded from SLO by adding entry here. For semantic see SloMetadata.exclusions. If both instance and node level exclusions are present for time period, the node level's reason will be reported by Eligibility Exporter. + */ + exclusions?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion[]; + /** + * The location of the node, if different from instance location. + */ + location?: string; + /** + * The id of the node. This should be equal to SaasInstanceNode.node_id. + */ + nodeId?: string; + } /** * NotificationMetadata is the notification state for an instance. */ @@ -245,7 +285,7 @@ export namespace file_v1beta1 { rolloutName?: string; } /** - * A temporal SLO exclusion specification. + * SloExclusion represents an excusion in SLI calculation applies to all SLOs. */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion { /** @@ -261,9 +301,9 @@ export namespace file_v1beta1 { */ reason?: string; /** - * Name of an SLI/SLO that this exclusion applies to. Can be left empty, signaling that the instance should be excluded from all SLI/SLOs defined in the service SLO configuration. + * Name of an SLI that this exclusion applies to. Can be left empty, signaling that the instance should be excluded from all SLIs defined in the service SLO configuration. */ - sloName?: string; + sliName?: string; } /** * SloMetadata contains resources required for proper SLO classification of the instance. @@ -273,6 +313,10 @@ export namespace file_v1beta1 { * List of SLO exclusion windows. When multiple entries in the list match (matching the exclusion time-window against current time point) the exclusion reason used in the first matching entry will be published. It is not needed to include expired exclusion in this list, as only the currently applicable exclusions are taken into account by the eligibility exporting subsystem (the historical state of exclusions will be reflected in the historically produced timeseries regardless of the current state). This field can be used to mark the instance as temporary ineligible for the purpose of SLO calculation. For permanent instance SLO exclusion, a dedicated tier name can be used that does not have targets specified in the service SLO configuration. */ exclusions?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion[]; + /** + * Optional: list of nodes. Some producers need to use per-node metadata to calculate SLO. This field allows such producers to publish per-node SLO meta data, which will be consumed by SSA Eligibility Exporter and published in the form of per node metric to Monarch. + */ + nodes?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata[]; /** * Name of the SLO tier the Instance belongs to. This name will be expected to match the tiers specified in the service SLO configuration. Field is mandatory and must not be empty. */ @@ -429,7 +473,7 @@ export namespace file_v1beta1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -471,7 +515,7 @@ export namespace file_v1beta1 { verb?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/file/webpack.config.js b/src/apis/file/webpack.config.js index 41a233655ae..90a86507954 100644 --- a/src/apis/file/webpack.config.js +++ b/src/apis/file/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/firebase/README.md b/src/apis/firebase/README.md new file mode 100644 index 00000000000..037468e1618 --- /dev/null +++ b/src/apis/firebase/README.md @@ -0,0 +1,47 @@ +Google Inc. logo + +# firebase + +> The Firebase Management API enables programmatic setup and management of Firebase projects, including a project's Firebase resources and Firebase apps. + +## Installation + +```sh +$ npm install googleapis +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). + +## Building a browser bundle + +This library can be used in a browser. To prepare a single file bundle, clone the +[repository](https://github.com/googleapis/google-api-nodejs-client) and run + +```sh +$ cd src/apis/firebase +$ npm install +$ npm run webpack +``` + +The generated bundle will be written to `dist/firebase.min.js`. Use it from your HTML file: + +```html + + +``` + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/master/LICENSE). + +## 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/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/firebase/index.ts b/src/apis/firebase/index.ts new file mode 100644 index 00000000000..7d0ba0f0d7d --- /dev/null +++ b/src/apis/firebase/index.ts @@ -0,0 +1,35 @@ +// Copyright 2019 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 {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {firebase_v1beta1} from './v1beta1'; + +export const VERSIONS = { + v1beta1: firebase_v1beta1.Firebase, +}; + +export function firebase(version: 'v1beta1'): firebase_v1beta1.Firebase; +export function firebase( + options: firebase_v1beta1.Options +): firebase_v1beta1.Firebase; +export function firebase( + this: GoogleConfigurable, + versionOrOptions: 'v1beta1' | firebase_v1beta1.Options +) { + return getAPI('firebase', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; diff --git a/src/apis/firebase/package.json b/src/apis/firebase/package.json new file mode 100644 index 00000000000..91c859a9d72 --- /dev/null +++ b/src/apis/firebase/package.json @@ -0,0 +1,43 @@ +{ + "name": "@google/firebase", + "version": "0.1.0", + "description": "firebase", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=8.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "docs": "typedoc --out docs/", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^2.0.4" + }, + "devDependencies": { + "gts": "^1.0.0", + "null-loader": "^3.0.0", + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" + } +} diff --git a/src/apis/firebase/tsconfig.json b/src/apis/firebase/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/firebase/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/firebase/v1beta1.ts b/src/apis/firebase/v1beta1.ts new file mode 100644 index 00000000000..85f52af479e --- /dev/null +++ b/src/apis/firebase/v1beta1.ts @@ -0,0 +1,3202 @@ +/** + * Copyright 2019 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. + */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace firebase_v1beta1 { + export interface Options extends GlobalOptions { + version: 'v1beta1'; + } + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Firebase Management API + * + * The Firebase Management API enables programmatic setup and management of Firebase projects, including a project's Firebase resources and Firebase apps. + * + * @example + * const {google} = require('googleapis'); + * const firebase = google.firebase('v1beta1'); + * + * @namespace firebase + * @type {Function} + * @version v1beta1 + * @variation v1beta1 + * @param {object=} options Options for Firebase + */ + export class Firebase { + context: APIRequestContext; + availableProjects: Resource$Availableprojects; + operations: Resource$Operations; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.availableProjects = new Resource$Availableprojects(this.context); + this.operations = new Resource$Operations(this.context); + this.projects = new Resource$Projects(this.context); + } + } + + /** + * All fields are required. + */ + export interface Schema$AddFirebaseRequest { + /** + * Deprecated. Instead, to set your project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase services to your project. <br> <br>The ID of the project's default GCP resource location. The location must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). + */ + locationId?: string; + /** + * The region code (CLDR) that the account will use for Firebase Analytics data. <br>For example: US, GB, or DE <br> <br>In Java, use `com.google.i18n.identifiers.RegionCode`. + */ + regionCode?: string; + /** + * The time zone that the account will use for Firebase Analytics data. <br>For example: America/Los_Angeles or Africa/Abidjan + */ + timeZone?: string; + } + export interface Schema$AdminSdkConfig { + /** + * The default Firebase Realtime Database URL. + */ + databaseURL?: string; + /** + * The ID of the project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). <br> <br>This field is omitted if the default GCP resource location has not been finalized yet. To set your project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase services to your project. + */ + locationId?: string; + /** + * Immutable. The globally unique, user-assigned project ID of the parent Project. + */ + projectId?: string; + /** + * The default Cloud Storage for Firebase storage bucket name. + */ + storageBucket?: string; + } + /** + * Details of a Firebase App for Android. + */ + export interface Schema$AndroidApp { + /** + * Immutable. The globally unique, Firebase-assigned identifier of the App. <br> <br>This identifier should be treated as an opaque token, as the data format is not specified. + */ + appId?: string; + /** + * The user-assigned display name of the App. + */ + displayName?: string; + /** + * The fully qualified resource name of the App, in the format: <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code> + */ + name?: string; + /** + * The canonical package name of the Android App as would appear in the Google Play Developer Console. + */ + packageName?: string; + /** + * The globally unique, user-assigned ID of the parent Project for the App. + */ + projectId?: string; + } + /** + * Configuration metadata of a single Firebase App for Android. + */ + export interface Schema$AndroidAppConfig { + /** + * The contents of the JSON configuration file. + */ + configFileContents?: string; + /** + * The filename that the configuration artifact is typically saved as. <br>For example: `google-services.json` + */ + configFilename?: string; + } + /** + * The default resources associated with a `FirebaseProject`. + */ + export interface Schema$DefaultResources { + /** + * The default Firebase Hosting site name, in the format: <br><code><var>projectId</var></code> <br>Though rare, your `projectId` might already be used as the name for an existing Hosting site in another project (learn more about creating non-default, [additional sites](https://firebase.google.com/docs/hosting/multisites)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Hosting site name. For example, if your `projectId` is `myproject123`, your default Hosting site name might be: <br><code>myproject123-a5c16</code> + */ + hostingSite?: string; + /** + * The ID of the project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). <br> <br>This field is omitted if the default GCP resource location has not been finalized yet. To set your project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase services to your project. + */ + locationId?: string; + /** + * The default Firebase Realtime Database instance name, in the format: <br><code><var>projectId</var></code> <br>Though rare, your `projectId` might already be used as the name for an existing Realtime Database instance in another project (learn more about [database sharding](https://firebase.google.com/docs/database/usage/sharding)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Realtime Database instance name. For example, if your `projectId` is `myproject123`, your default database instance name might be: <br><code>myproject123-a5c16</code> + */ + realtimeDatabaseInstance?: string; + /** + * The default Cloud Storage for Firebase storage bucket, in the format: <br><code><var>projectId</var>.appspot.com</code> + */ + storageBucket?: 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 {} + export interface Schema$FinalizeDefaultLocationRequest { + /** + * The ID of the default GCP resource location for the Project. The location must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). + */ + locationId?: string; + } + /** + * A high-level summary of an App. + */ + export interface Schema$FirebaseAppInfo { + /** + * Immutable. The globally unique, Firebase-assigned identifier of the App. <br> <br>This identifier should be treated as an opaque token, as the data format is not specified. + */ + appId?: string; + /** + * The user-assigned display name of the Firebase App. + */ + displayName?: string; + /** + * The fully qualified resource name of the Firebase App, in the format: <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code> or <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var> </code> + */ + name?: string; + /** + * The platform of the Firebase App. + */ + platform?: string; + } + /** + * A `FirebaseProject` is the top-level Firebase entity. It is the container for Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime Database, Cloud Firestore, Cloud Storage buckets) and other Firebase and Google Cloud Platform (GCP) resources. <br> <br>You can create a new `FirebaseProject` in the [Firebase console](https://console.firebase.google.com/), or you can add Firebase resources to an existing [GCP `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects) by calling AddFirebase. <br> <br>A `FirebaseProject` is actually also a GCP `Project`, so a `FirebaseProject` uses underlying GCP identifiers (most importantly, `projectId`) as its own for easy interop with GCP APIs. + */ + export interface Schema$FirebaseProject { + /** + * The user-assigned display name of the Project. + */ + displayName?: string; + /** + * The fully qualified resource name of the Project, in the format: <br><code>projects/<var>projectId</var></code> + */ + name?: string; + /** + * Immutable. The globally unique, user-assigned ID of the Project. + */ + projectId?: string; + /** + * The globally unique, Google-assigned identifier of the Project. + */ + projectNumber?: string; + /** + * The default Firebase resources associated with the Project. + */ + resources?: Schema$DefaultResources; + } + /** + * Details of a Firebase App for iOS. + */ + export interface Schema$IosApp { + /** + * Immutable. The globally unique, Firebase-assigned identifier of the App. <br> <br>This identifier should be treated as an opaque token, as the data format is not specified. + */ + appId?: string; + /** + * The automatically generated Apple ID assigned to the App by Apple in the iOS App Store. + */ + appStoreId?: string; + /** + * The canonical bundle ID of the iOS App as it would appear in the iOS AppStore. + */ + bundleId?: string; + /** + * The user-assigned display name of the App. + */ + displayName?: string; + /** + * The fully qualified resource name of the App, in the format: <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code> + */ + name?: string; + /** + * The globally unique, user-assigned ID of the parent Project for the App. + */ + projectId?: string; + } + /** + * Configuration metadata of a single Firebase App for iOS. + */ + export interface Schema$IosAppConfig { + /** + * The content of the XML configuration file. + */ + configFileContents?: string; + /** + * The filename that the configuration artifact is typically saved as. <br>For example: `GoogleService-Info.plist` + */ + configFilename?: string; + } + export interface Schema$ListAndroidAppsResponse { + /** + * List of each AndroidApp that is in the parent Firebase Project. + */ + apps?: Schema$AndroidApp[]; + /** + * If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. <br> <br>This token can be used in a subsequent call to `ListAndroidApps` to find the next group of Apps. <br> <br>Page tokens are short-lived and should not be persisted. + */ + nextPageToken?: string; + } + export interface Schema$ListAvailableLocationsResponse { + /** + * One page of results from a call to `ListAvailableLocations`. + */ + locations?: Schema$Location[]; + /** + * If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results and all available locations have been listed. <br> <br>This token can be used in a subsequent call to `ListAvailableLocations` to find more locations. <br> <br>Page tokens are short-lived and should not be persisted. + */ + nextPageToken?: string; + } + export interface Schema$ListAvailableProjectsResponse { + /** + * If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. <br> <br>This token can be used in a subsequent calls to `ListAvailableProjects` to find the next group of GCP `Projects`. <br> <br>Page tokens are short-lived and should not be persisted. + */ + nextPageToken?: string; + /** + * The list of GCP `Projects` which can have Firebase resources added to them. + */ + projectInfo?: Schema$ProjectInfo[]; + } + export interface Schema$ListFirebaseProjectsResponse { + /** + * If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. <br> <br>This token can be used in a subsequent calls to `ListFirebaseProjects` to find the next group of Projects. <br> <br>Page tokens are short-lived and should not be persisted. + */ + nextPageToken?: string; + /** + * One page of the list of Projects that are accessible to the caller. + */ + results?: Schema$FirebaseProject[]; + } + export interface Schema$ListIosAppsResponse { + /** + * List of each IosApp that is in the parent Firebase Project. + */ + apps?: Schema$IosApp[]; + /** + * If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. <br> <br>This token can be used in a subsequent call to `ListIosApps` to find the next group of Apps. <br> <br>Page tokens are short-lived and should not be persisted. + */ + nextPageToken?: string; + } + export interface Schema$ListShaCertificatesResponse { + /** + * The list of SHA certificates associated with the App. + */ + certificates?: Schema$ShaCertificate[]; + } + export interface Schema$ListWebAppsResponse { + /** + * List of each WebApp that is in the parent Firebase Project. + */ + apps?: Schema$WebApp[]; + /** + * If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. <br> <br>This token can be used in a subsequent call to `ListWebApps` to find the next group of Apps. <br> <br>Page tokens are short-lived and should not be persisted. + */ + nextPageToken?: string; + } + /** + * A GCP resource location that can be selected for a Project. + */ + export interface Schema$Location { + /** + * The ID of the default GCP resource location. It must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). + */ + locationId?: string; + } + /** + * This is proto2's version of MessageSet. + */ + export interface Schema$MessageSet {} + /** + * 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?: {[key: string]: 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 be a resource name ending with `operations/{unique_id}`. + */ + 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?: {[key: string]: any}; + } + /** + * A reference to a Google Cloud Platform (GCP) `Project`. + */ + export interface Schema$ProjectInfo { + /** + * The user-assigned display name of the GCP `Project`, for example: <code>My App</code> + */ + displayName?: string; + /** + * The ID of the project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). <br> <br> Not all projects will have this field populated. If it is not populated, it means that the project does not yet have a default GCP resource location. To set your project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase services to your project. + */ + locationId?: string; + /** + * The resource name of the GCP `Project` to which Firebase resources can be added, in the format: <br><code>projects/<var>projectId</var></code> + */ + project?: string; + } + export interface Schema$SearchFirebaseAppsResponse { + /** + * One page of results from a call to `SearchFirebaseApps`. + */ + apps?: Schema$FirebaseAppInfo[]; + /** + * If the result list is too large to fit in a single response, then a token is returned. <br> <br>This token can be used in a subsequent calls to `SearchFirebaseApps` to find the next group of Apps. <br>If the string is empty, then this response is the last page of results. <br>Page tokens are short-lived and should not be persisted. + */ + nextPageToken?: string; + } + /** + * A SHA-1 or SHA-256 certificate associated with the AndroidApp. + */ + export interface Schema$ShaCertificate { + /** + * The SHA certificate type. + */ + certType?: string; + /** + * The fully qualified resource name of the `sha-key`, in the format: <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var>/sha/<var>shaId</var></code> + */ + name?: string; + /** + * The certificate hash for the App. + */ + shaHash?: string; + } + /** + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + 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?: Array<{[key: string]: 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; + } + /** + * Wire-format for a Status object + */ + export interface Schema$StatusProto { + /** + * The canonical error code (see codes.proto) that most closely corresponds to this status. May be missing. + */ + canonicalCode?: number; + /** + * Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto + */ + code?: number; + /** + * Detail message + */ + message?: string; + /** + * message_set associates an arbitrary proto message with the status. + */ + messageSet?: Schema$MessageSet; + /** + * DEPRECATED. This field was deprecated in 2011 with cl/20297133. Java support for the field was moved to a proto1 backward compatibility class in April 2017 with cl/142615857 and cl/154123203. There was never support for this field in Go; if set Go will ignore it. C++ stopped setting StatusProto::payload in October 2015 with cl/106347055, and stopped reading the field in October 2017 with cl/173324114. In general, newly written code should use only "message_set". If you need to maintain backward compatibility with code written before 3/25/2011, do the following: - During the transition period, either (1) set both "payload" and "message_set", or (2) write the consumer of StatusProto so that it can forge a MessageSet object from "payload" if "message_set" is missing. The C++ util::Status implementation does (2). - Once all the consumers are converted to accept "message_set", then remove the use of "payload" on the producer side. + */ + payload?: Schema$TypedMessage; + /** + * The following are usually only present when code != 0 Space to which this status belongs + */ + space?: string; + } + /** + * Message that groups a protocol type_id (as defined by MessageSet), with an encoded message of that type. Its use is similar to MessageSet, except it represents a single (type, encoded message) instead of a set. To fill for known protocol type: MyProtocolMsg proto; TypedMessage typed_msg; typed_msg.set_type_id(MyProtocolMsg::MESSAGE_TYPE_ID); proto.AppendToCord(typed_msg.mutable_message()); To fill for unknown protocol type: ProtocolMessage proto; TypedMessage typed_msg; typed_msg.set_type_id(proto.GetMapper()->type_id()); proto.AppendToCord(typed_msg.mutable_message()); + */ + export interface Schema$TypedMessage { + /** + * Message bytes. + */ + message?: string; + /** + * Identifier for the type. + */ + typeId?: number; + } + /** + * Details of a Firebase App for the web. + */ + export interface Schema$WebApp { + /** + * Immutable. The globally unique, Firebase-assigned identifier of the App. <br> <br>This identifier should be treated as an opaque token, as the data format is not specified. + */ + appId?: string; + /** + * The fully qualified URLs where the App is hosted. + */ + appUrls?: string[]; + /** + * The user-assigned display name of the App. + */ + displayName?: string; + /** + * The fully qualified resource name of the App, for example: <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code> + */ + name?: string; + /** + * The globally unique, user-assigned ID of the parent Project for the App. + */ + projectId?: string; + } + /** + * Configuration metadata of a single Firebase App for the web. + */ + export interface Schema$WebAppConfig { + /** + * The API key associated with the web App. + */ + apiKey?: string; + /** + * Immutable. The globally unique, Firebase-assigned identifier of the App. + */ + appId?: string; + /** + * The domain Firebase Auth configures for OAuth redirects, in the format: <br><code><var>projectId</var>.firebaseapp.com</code> + */ + authDomain?: string; + /** + * The default Firebase Realtime Database URL. + */ + databaseURL?: string; + /** + * The ID of the project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). <br> <br>This field is omitted if the default GCP resource location has not been finalized yet. To set your project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase services to your project. + */ + locationId?: string; + /** + * The sender ID for use with Firebase Cloud Messaging. + */ + messagingSenderId?: string; + /** + * Immutable. The globally unique, user-assigned project ID of the parent Project for the App. + */ + projectId?: string; + /** + * The default Cloud Storage for Firebase storage bucket name. + */ + storageBucket?: string; + } + + export class Resource$Availableprojects { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * firebase.availableProjects.list + * @desc Returns a list of [Google Cloud Platform (GCP) `Projects`] (https://cloud.google.com/resource-manager/reference/rest/v1/projects) that are available to have Firebase resources added to them.

A GCP `Project` will only be returned if:

  1. The caller has sufficient [Google IAM](https://cloud.google.com/iam) permissions to call AddFirebase.

  2. The GCP `Project` is not already a FirebaseProject.

  3. The GCP `Project` is not in an Organization which has policies that prevent Firebase resources from being added.

+ * @alias firebase.availableProjects.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of GCP `Projects` to return in the response.

The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.

This value cannot be negative. + * @param {string=} params.pageToken Token returned from a previous call to `ListAvailableProjects` indicating where in the set of GCP `Projects` to resume listing. + * @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$Availableprojects$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Availableprojects$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Availableprojects$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Availableprojects$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Availableprojects$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Availableprojects$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/availableProjects').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Availableprojects$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of GCP `Projects` to return in the response.

The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.

This value cannot be negative. + */ + pageSize?: number; + /** + * Token returned from a previous call to `ListAvailableProjects` indicating where in the set of GCP `Projects` to resume listing. + */ + pageToken?: string; + } + + export class Resource$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * firebase.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 firebase.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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Operations$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource. + */ + name?: string; + } + + export class Resource$Projects { + context: APIRequestContext; + androidApps: Resource$Projects$Androidapps; + availableLocations: Resource$Projects$Availablelocations; + defaultLocation: Resource$Projects$Defaultlocation; + iosApps: Resource$Projects$Iosapps; + webApps: Resource$Projects$Webapps; + constructor(context: APIRequestContext) { + this.context = context; + this.androidApps = new Resource$Projects$Androidapps(this.context); + this.availableLocations = new Resource$Projects$Availablelocations( + this.context + ); + this.defaultLocation = new Resource$Projects$Defaultlocation( + this.context + ); + this.iosApps = new Resource$Projects$Iosapps(this.context); + this.webApps = new Resource$Projects$Webapps(this.context); + } + + /** + * firebase.projects.addFirebase + * @desc Adds Firebase resources to the specified existing [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource-manager/reference/rest/v1/projects).

Since a FirebaseProject is actually also a GCP `Project`, a `FirebaseProject` uses underlying GCP identifiers (most importantly, the `projectId`) as its own for easy interop with GCP APIs.

The result of this call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to track the provisioning process by calling GetOperation until [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or failed. If the `Operation` succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to a FirebaseProject; if the `Operation` failed, its [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call DeleteOperation.

This method does not modify any billing account information on the underlying GCP `Project`.

All fields listed in the [request body](#request-body) are required.

To call `AddFirebase`, a member must be an Editor or Owner for the existing GCP `Project`. Service accounts cannot call `AddFirebase`. + * @alias firebase.projects.addFirebase + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project The resource name of the GCP `Project` to which Firebase resources will be added, in the format:
projects/projectId After calling `AddFirebase`, the [`projectId`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id) of the GCP `Project` is also the `projectId` of the FirebaseProject. + * @param {().AddFirebaseRequest} 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 + */ + addFirebase( + params?: Params$Resource$Projects$Addfirebase, + options?: MethodOptions + ): GaxiosPromise; + addFirebase( + params: Params$Resource$Projects$Addfirebase, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addFirebase( + params: Params$Resource$Projects$Addfirebase, + callback: BodyResponseCallback + ): void; + addFirebase(callback: BodyResponseCallback): void; + addFirebase( + paramsOrCallback?: + | Params$Resource$Projects$Addfirebase + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Addfirebase; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Addfirebase; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+project}:addFirebase').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.get + * @desc Gets the FirebaseProject identified by the specified resource name. + * @alias firebase.projects.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The fully qualified resource name of the Project, in the format:
projects/projectId + * @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$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Projects$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.getAdminSdkConfig + * @desc Gets the configuration artifact used by servers to simplify initialization.

Typically, this configuration is used with the Firebase Admin SDK [initializeApp](https://firebase.google.com/docs/admin/setup#initialize_the_sdk) command. + * @alias firebase.projects.getAdminSdkConfig + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The fully qualified resource name of the Project, in the format:
projects/projectId/adminSdkConfig + * @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 + */ + getAdminSdkConfig( + params?: Params$Resource$Projects$Getadminsdkconfig, + options?: MethodOptions + ): GaxiosPromise; + getAdminSdkConfig( + params: Params$Resource$Projects$Getadminsdkconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAdminSdkConfig( + params: Params$Resource$Projects$Getadminsdkconfig, + callback: BodyResponseCallback + ): void; + getAdminSdkConfig( + callback: BodyResponseCallback + ): void; + getAdminSdkConfig( + paramsOrCallback?: + | Params$Resource$Projects$Getadminsdkconfig + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Getadminsdkconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Getadminsdkconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.list + * @desc Lists each FirebaseProject accessible to the caller.

The elements are returned in no particular order, but they will be a consistent view of the Projects when additional requests are made with a `pageToken`.

This method is eventually consistent with Project mutations, which means newly provisioned Projects and recent modifications to existing Projects might not be reflected in the set of Projects. The list will include only ACTIVE Projects.

Use GetFirebaseProject for consistent reads as well as for additional Project details. + * @alias firebase.projects.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of Projects to return in the response.

The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.

This value cannot be negative. + * @param {string=} params.pageToken Token returned from a previous call to `ListFirebaseProjects` indicating where in the set of Projects to resume listing. + * @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$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Projects$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/projects').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * firebase.projects.patch + * @desc Updates the attributes of the FirebaseProject identified by the specified resource name.

All [query parameters](#query-parameters) are required. + * @alias firebase.projects.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The fully qualified resource name of the Project, in the format:
projects/projectId + * @param {string=} params.updateMask Specifies which fields to update.

If this list is empty, then no state will be updated.
Note that the fields `name`, `project_id`, and `project_number` are all immutable. + * @param {().FirebaseProject} 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$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Projects$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.searchApps + * @desc A convenience method that lists all available Apps for the specified FirebaseProject.

Typically, interaction with an App should be done using the platform-specific service, but some tool use-cases require a summary of all known Apps (such as for App selector interfaces). + * @alias firebase.projects.searchApps + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of Apps to return in the response.

The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit.

This value cannot be negative. + * @param {string=} params.pageToken Token returned from a previous call to `SearchFirebaseApps` indicating where in the set of Apps to resume listing. + * @param {string} params.parent The parent Project for which to list Apps, in the format:
projects/projectId + * @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 + */ + searchApps( + params?: Params$Resource$Projects$Searchapps, + options?: MethodOptions + ): GaxiosPromise; + searchApps( + params: Params$Resource$Projects$Searchapps, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchApps( + params: Params$Resource$Projects$Searchapps, + callback: BodyResponseCallback + ): void; + searchApps( + callback: BodyResponseCallback + ): void; + searchApps( + paramsOrCallback?: + | Params$Resource$Projects$Searchapps + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Searchapps; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Searchapps; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}:searchApps').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Addfirebase + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The resource name of the GCP `Project` to which Firebase resources will be added, in the format:
projects/projectId After calling `AddFirebase`, the [`projectId`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id) of the GCP `Project` is also the `projectId` of the FirebaseProject. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AddFirebaseRequest; + } + export interface Params$Resource$Projects$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The fully qualified resource name of the Project, in the format:
projects/projectId + */ + name?: string; + } + export interface Params$Resource$Projects$Getadminsdkconfig + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The fully qualified resource name of the Project, in the format:
projects/projectId/adminSdkConfig + */ + name?: string; + } + export interface Params$Resource$Projects$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of Projects to return in the response.

The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.

This value cannot be negative. + */ + pageSize?: number; + /** + * Token returned from a previous call to `ListFirebaseProjects` indicating where in the set of Projects to resume listing. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The fully qualified resource name of the Project, in the format:
projects/projectId + */ + name?: string; + /** + * Specifies which fields to update.

If this list is empty, then no state will be updated.
Note that the fields `name`, `project_id`, and `project_number` are all immutable. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirebaseProject; + } + export interface Params$Resource$Projects$Searchapps + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of Apps to return in the response.

The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit.

This value cannot be negative. + */ + pageSize?: number; + /** + * Token returned from a previous call to `SearchFirebaseApps` indicating where in the set of Apps to resume listing. + */ + pageToken?: string; + /** + * The parent Project for which to list Apps, in the format:
projects/projectId + */ + parent?: string; + } + + export class Resource$Projects$Androidapps { + context: APIRequestContext; + sha: Resource$Projects$Androidapps$Sha; + constructor(context: APIRequestContext) { + this.context = context; + this.sha = new Resource$Projects$Androidapps$Sha(this.context); + } + + /** + * firebase.projects.androidApps.create + * @desc Requests that a new AndroidApp be created.

The result of this call is an `Operation` which can be used to track the provisioning process. The `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`. + * @alias firebase.projects.androidApps.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The parent Project for which to list Apps, in the format:
projects/projectId + * @param {().AndroidApp} 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$Androidapps$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Androidapps$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Androidapps$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Androidapps$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Androidapps$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Androidapps$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/androidApps').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.androidApps.get + * @desc Gets the AndroidApp identified by the specified resource name. + * @alias firebase.projects.androidApps.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The fully qualified resource name of the App, in the format:
projects/projectId/androidApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/appId + * @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$Androidapps$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Androidapps$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Androidapps$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Androidapps$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Androidapps$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Androidapps$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.androidApps.getConfig + * @desc Gets the configuration artifact associated with the specified AndroidApp. + * @alias firebase.projects.androidApps.getConfig + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the App configuration to download, in the format:
projects/projectId/androidApps/appId/config
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/appId + * @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 + */ + getConfig( + params?: Params$Resource$Projects$Androidapps$Getconfig, + options?: MethodOptions + ): GaxiosPromise; + getConfig( + params: Params$Resource$Projects$Androidapps$Getconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getConfig( + params: Params$Resource$Projects$Androidapps$Getconfig, + callback: BodyResponseCallback + ): void; + getConfig(callback: BodyResponseCallback): void; + getConfig( + paramsOrCallback?: + | Params$Resource$Projects$Androidapps$Getconfig + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Androidapps$Getconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Androidapps$Getconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.androidApps.list + * @desc Lists each AndroidApp associated with the specified parent Project.

The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a `pageToken`. + * @alias firebase.projects.androidApps.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of Apps to return in the response.

The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit. + * @param {string=} params.pageToken Token returned from a previous call to `ListAndroidApps` indicating where in the set of Apps to resume listing. + * @param {string} params.parent The parent Project for which to list Apps, in the format:
projects/projectId + * @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$Androidapps$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Androidapps$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Androidapps$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Androidapps$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Androidapps$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Androidapps$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/androidApps').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.androidApps.patch + * @desc Updates the attributes of the AndroidApp identified by the specified resource name. + * @alias firebase.projects.androidApps.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The fully qualified resource name of the App, in the format:
projects/projectId/androidApps/appId + * @param {string=} params.updateMask Specifies which fields to update.
Note that the fields `name`, `appId`, `projectId`, and `packageName` are all immutable. + * @param {().AndroidApp} 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$Androidapps$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Androidapps$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Androidapps$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Androidapps$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Androidapps$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Androidapps$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Androidapps$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The parent Project for which to list Apps, in the format:
projects/projectId + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AndroidApp; + } + export interface Params$Resource$Projects$Androidapps$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The fully qualified resource name of the App, in the format:
projects/projectId/androidApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/appId + */ + name?: string; + } + export interface Params$Resource$Projects$Androidapps$Getconfig + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The resource name of the App configuration to download, in the format:
projects/projectId/androidApps/appId/config
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/appId + */ + name?: string; + } + export interface Params$Resource$Projects$Androidapps$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of Apps to return in the response.

The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit. + */ + pageSize?: number; + /** + * Token returned from a previous call to `ListAndroidApps` indicating where in the set of Apps to resume listing. + */ + pageToken?: string; + /** + * The parent Project for which to list Apps, in the format:
projects/projectId + */ + parent?: string; + } + export interface Params$Resource$Projects$Androidapps$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The fully qualified resource name of the App, in the format:
projects/projectId/androidApps/appId + */ + name?: string; + /** + * Specifies which fields to update.
Note that the fields `name`, `appId`, `projectId`, and `packageName` are all immutable. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AndroidApp; + } + + export class Resource$Projects$Androidapps$Sha { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * firebase.projects.androidApps.sha.create + * @desc Adds a SHA certificate to the specified AndroidApp. + * @alias firebase.projects.androidApps.sha.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The parent App to which a SHA certificate will be added, in the format:
projects/projectId/androidApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/appId + * @param {().ShaCertificate} 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$Androidapps$Sha$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Androidapps$Sha$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Androidapps$Sha$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Androidapps$Sha$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Androidapps$Sha$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Androidapps$Sha$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/sha').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.androidApps.sha.delete + * @desc Removes a SHA certificate from the specified AndroidApp. + * @alias firebase.projects.androidApps.sha.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The fully qualified resource name of the `sha-key`, in the format:
projects/projectId/androidApps/appId/sha/shaId
You can obtain the full name from the response of [`ListShaCertificates`](../projects.androidApps.sha/list) or the original [`CreateShaCertificate`](../projects.androidApps.sha/create). + * @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$Projects$Androidapps$Sha$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Androidapps$Sha$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Androidapps$Sha$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Androidapps$Sha$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Androidapps$Sha$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Androidapps$Sha$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.androidApps.sha.list + * @desc Returns the list of SHA-1 and SHA-256 certificates for the specified AndroidApp. + * @alias firebase.projects.androidApps.sha.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The parent App for which to list SHA certificates, in the format:
projects/projectId/androidApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/appId + * @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$Androidapps$Sha$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Androidapps$Sha$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Androidapps$Sha$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Androidapps$Sha$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Androidapps$Sha$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Androidapps$Sha$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/sha').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Androidapps$Sha$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The parent App to which a SHA certificate will be added, in the format:
projects/projectId/androidApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/appId + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ShaCertificate; + } + export interface Params$Resource$Projects$Androidapps$Sha$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The fully qualified resource name of the `sha-key`, in the format:
projects/projectId/androidApps/appId/sha/shaId
You can obtain the full name from the response of [`ListShaCertificates`](../projects.androidApps.sha/list) or the original [`CreateShaCertificate`](../projects.androidApps.sha/create). + */ + name?: string; + } + export interface Params$Resource$Projects$Androidapps$Sha$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The parent App for which to list SHA certificates, in the format:
projects/projectId/androidApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/androidApps/appId + */ + parent?: string; + } + + export class Resource$Projects$Availablelocations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * firebase.projects.availableLocations.list + * @desc Returns a list of valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject).

The default GCP resource location of a project defines the geographical location where project resources, such as Cloud Firestore, will be provisioned by default.

The returned list are the available [GCP resource locations](https://firebase.google.com/docs/projects/locations).

This call checks for any location restrictions for the specified Project and, thus, might return a subset of all possible GCP resource locations. To list all GCP resource locations (regardless of any restrictions), call the endpoint without specifying a `projectId` (that is, `/v1beta1/{parent=projects/-}/listAvailableLocations`).

To call `ListAvailableLocations` with a specified project, a member must be at minimum a Viewer of the project. Calls without a specified project do not require any specific project permissions. + * @alias firebase.projects.availableLocations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of locations to return in the response.

The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit.

This value cannot be negative. + * @param {string=} params.pageToken Token returned from a previous call to `ListAvailableLocations` indicating where in the list of locations to resume listing. + * @param {string} params.parent The Project for which to list GCP resource locations, in the format:
projects/projectId
If no project is specified (that is, `projects/-`), the returned list does not take into account org-specific or project-specific location restrictions. + * @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$Availablelocations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Availablelocations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Availablelocations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Availablelocations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Availablelocations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Availablelocations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/availableLocations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Availablelocations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of locations to return in the response.

The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit.

This value cannot be negative. + */ + pageSize?: number; + /** + * Token returned from a previous call to `ListAvailableLocations` indicating where in the list of locations to resume listing. + */ + pageToken?: string; + /** + * The Project for which to list GCP resource locations, in the format:
projects/projectId
If no project is specified (that is, `projects/-`), the returned list does not take into account org-specific or project-specific location restrictions. + */ + parent?: string; + } + + export class Resource$Projects$Defaultlocation { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * firebase.projects.defaultLocation.finalize + * @desc Sets the default Google Cloud Platform (GCP) resource location for the specified FirebaseProject.

This method creates an App Engine application with a [default Cloud Storage bucket](https://cloud.google.com/appengine/docs/standard/python/googlecloudstorageclient/setting-up-cloud-storage#activating_a_cloud_storage_bucket), located in the specified [`location_id`](#body.request_body.FIELDS.location_id). This location must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations).

After the default GCP resource location is finalized, or if it was already set, it cannot be changed. The default GCP resource location for the specified FirebaseProject might already be set because either the GCP `Project` already has an App Engine application or `FinalizeDefaultLocation` was previously called with a specified `location_id`. Any new calls to `FinalizeDefaultLocation` with a different specified `location_id` will return a 409 error.

The result of this call is an [`Operation`](../../v1beta1/operations), which can be used to track the provisioning process. The [`response`](../../v1beta1/operations#Operation.FIELDS.response) type of the `Operation` is google.protobuf.Empty.

The `Operation` can be polled by its `name` using GetOperation until `done` is true. When `done` is true, the `Operation` has either succeeded or failed. If the `Operation` has succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) will be set to a google.protobuf.Empty; if the `Operation` has failed, its `error` will be set to a google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call DeleteOperation.

All fields listed in the [request body](#request-body) are required.

To call `FinalizeDefaultLocation`, a member must be an Owner of the project. + * @alias firebase.projects.defaultLocation.finalize + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The resource name of the Project for which the default GCP resource location will be set, in the format:
projects/projectId + * @param {().FinalizeDefaultLocationRequest} 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 + */ + finalize( + params?: Params$Resource$Projects$Defaultlocation$Finalize, + options?: MethodOptions + ): GaxiosPromise; + finalize( + params: Params$Resource$Projects$Defaultlocation$Finalize, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + finalize( + params: Params$Resource$Projects$Defaultlocation$Finalize, + callback: BodyResponseCallback + ): void; + finalize(callback: BodyResponseCallback): void; + finalize( + paramsOrCallback?: + | Params$Resource$Projects$Defaultlocation$Finalize + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Defaultlocation$Finalize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Defaultlocation$Finalize; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/defaultLocation:finalize' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Defaultlocation$Finalize + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The resource name of the Project for which the default GCP resource location will be set, in the format:
projects/projectId + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FinalizeDefaultLocationRequest; + } + + export class Resource$Projects$Iosapps { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * firebase.projects.iosApps.create + * @desc Requests that a new IosApp be created.

The result of this call is an `Operation` which can be used to track the provisioning process. The `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`. + * @alias firebase.projects.iosApps.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The parent Project for which to list Apps, in the format:
projects/projectId + * @param {().IosApp} 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$Iosapps$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Iosapps$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Iosapps$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Iosapps$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Iosapps$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Iosapps$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/iosApps').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.iosApps.get + * @desc Gets the IosApp identified by the specified resource name. + * @alias firebase.projects.iosApps.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The fully qualified resource name of the App, in the format: projects/projectId/iosApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/iosApps/appId + * @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$Iosapps$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Iosapps$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Iosapps$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Iosapps$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Iosapps$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Iosapps$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.iosApps.getConfig + * @desc Gets the configuration artifact associated with the specified IosApp. + * @alias firebase.projects.iosApps.getConfig + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the App configuration to download, in the format:
projects/projectId/iosApps/appId/config
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/iosApps/appId + * @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 + */ + getConfig( + params?: Params$Resource$Projects$Iosapps$Getconfig, + options?: MethodOptions + ): GaxiosPromise; + getConfig( + params: Params$Resource$Projects$Iosapps$Getconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getConfig( + params: Params$Resource$Projects$Iosapps$Getconfig, + callback: BodyResponseCallback + ): void; + getConfig(callback: BodyResponseCallback): void; + getConfig( + paramsOrCallback?: + | Params$Resource$Projects$Iosapps$Getconfig + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Iosapps$Getconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Iosapps$Getconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.iosApps.list + * @desc Lists each IosApp associated with the specified parent Project.

The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a `pageToken`. + * @alias firebase.projects.iosApps.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of Apps to return in the response.

The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. + * @param {string=} params.pageToken Token returned from a previous call to `ListIosApps` indicating where in the set of Apps to resume listing. + * @param {string} params.parent The parent Project for which to list Apps, in the format:
projects/projectId + * @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$Iosapps$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Iosapps$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Iosapps$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Iosapps$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Iosapps$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Iosapps$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/iosApps').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.iosApps.patch + * @desc Updates the attributes of the IosApp identified by the specified resource name. + * @alias firebase.projects.iosApps.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The fully qualified resource name of the App, in the format:
projects/projectId/iosApps/appId + * @param {string=} params.updateMask Specifies which fields to update.
Note that the fields `name`, `appId`, `projectId`, and `bundleId` are all immutable. + * @param {().IosApp} 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$Iosapps$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Iosapps$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Iosapps$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Iosapps$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Iosapps$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Iosapps$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Iosapps$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The parent Project for which to list Apps, in the format:
projects/projectId + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$IosApp; + } + export interface Params$Resource$Projects$Iosapps$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The fully qualified resource name of the App, in the format: projects/projectId/iosApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/iosApps/appId + */ + name?: string; + } + export interface Params$Resource$Projects$Iosapps$Getconfig + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The resource name of the App configuration to download, in the format:
projects/projectId/iosApps/appId/config
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/iosApps/appId + */ + name?: string; + } + export interface Params$Resource$Projects$Iosapps$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of Apps to return in the response.

The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. + */ + pageSize?: number; + /** + * Token returned from a previous call to `ListIosApps` indicating where in the set of Apps to resume listing. + */ + pageToken?: string; + /** + * The parent Project for which to list Apps, in the format:
projects/projectId + */ + parent?: string; + } + export interface Params$Resource$Projects$Iosapps$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The fully qualified resource name of the App, in the format:
projects/projectId/iosApps/appId + */ + name?: string; + /** + * Specifies which fields to update.
Note that the fields `name`, `appId`, `projectId`, and `bundleId` are all immutable. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$IosApp; + } + + export class Resource$Projects$Webapps { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * firebase.projects.webApps.create + * @desc Requests that a new WebApp be created.

The result of this call is an `Operation` which can be used to track the provisioning process. The `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`. + * @alias firebase.projects.webApps.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The parent Project for which to list Apps, in the format:
projects/projectId + * @param {().WebApp} 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$Webapps$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Webapps$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Webapps$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Webapps$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Webapps$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Webapps$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/webApps').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.webApps.get + * @desc Gets the WebApp identified by the specified resource name. + * @alias firebase.projects.webApps.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The fully qualified resource name of the App, in the format:
projects/projectId/webApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/webApps/appId + * @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$Webapps$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Webapps$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Webapps$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Webapps$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Webapps$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Webapps$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.webApps.getConfig + * @desc Gets the configuration artifact associated with the specified WebApp. + * @alias firebase.projects.webApps.getConfig + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the App configuration to download, in the format:
projects/projectId/webApps/appId/config
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/webApps/appId + * @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 + */ + getConfig( + params?: Params$Resource$Projects$Webapps$Getconfig, + options?: MethodOptions + ): GaxiosPromise; + getConfig( + params: Params$Resource$Projects$Webapps$Getconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getConfig( + params: Params$Resource$Projects$Webapps$Getconfig, + callback: BodyResponseCallback + ): void; + getConfig(callback: BodyResponseCallback): void; + getConfig( + paramsOrCallback?: + | Params$Resource$Projects$Webapps$Getconfig + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Webapps$Getconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Webapps$Getconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.webApps.list + * @desc Lists each WebApp associated with the specified parent Project.

The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a `pageToken`. + * @alias firebase.projects.webApps.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of Apps to return in the response.

The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit. + * @param {string=} params.pageToken Token returned from a previous call to `ListWebApps` indicating where in the set of Apps to resume listing. + * @param {string} params.parent The parent Project for which to list Apps, in the format:
projects/projectId + * @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$Webapps$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Webapps$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Webapps$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Webapps$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Webapps$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Webapps$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/webApps').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebase.projects.webApps.patch + * @desc Updates the attributes of the WebApp identified by the specified resource name. + * @alias firebase.projects.webApps.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The fully qualified resource name of the App, for example:
projects/projectId/webApps/appId + * @param {string=} params.updateMask Specifies which fields to update.
Note that the fields `name`, `appId`, and `projectId` are all immutable. + * @param {().WebApp} 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$Webapps$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Webapps$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Webapps$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Webapps$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Webapps$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Webapps$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Webapps$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The parent Project for which to list Apps, in the format:
projects/projectId + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WebApp; + } + export interface Params$Resource$Projects$Webapps$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The fully qualified resource name of the App, in the format:
projects/projectId/webApps/appId
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/webApps/appId + */ + name?: string; + } + export interface Params$Resource$Projects$Webapps$Getconfig + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The resource name of the App configuration to download, in the format:
projects/projectId/webApps/appId/config
As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
projects/-/webApps/appId + */ + name?: string; + } + export interface Params$Resource$Projects$Webapps$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of Apps to return in the response.

The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit. + */ + pageSize?: number; + /** + * Token returned from a previous call to `ListWebApps` indicating where in the set of Apps to resume listing. + */ + pageToken?: string; + /** + * The parent Project for which to list Apps, in the format:
projects/projectId + */ + parent?: string; + } + export interface Params$Resource$Projects$Webapps$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The fully qualified resource name of the App, for example:
projects/projectId/webApps/appId + */ + name?: string; + /** + * Specifies which fields to update.
Note that the fields `name`, `appId`, and `projectId` are all immutable. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WebApp; + } +} diff --git a/src/apis/firebase/webpack.config.js b/src/apis/firebase/webpack.config.js new file mode 100644 index 00000000000..68ce771b91a --- /dev/null +++ b/src/apis/firebase/webpack.config.js @@ -0,0 +1,71 @@ +/** + * Copyright 2019 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. + */ + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + }, + output: { + library: 'Firebase', + filename: 'firebase.min.js', + path: path.resolve(__dirname, 'dist'), + }, + node: { + child_process: 'empty', + fs: 'empty', + crypto: 'empty', + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/firebasedynamiclinks/package.json b/src/apis/firebasedynamiclinks/package.json index 626f6c96572..bdf0bbb53ab 100644 --- a/src/apis/firebasedynamiclinks/package.json +++ b/src/apis/firebasedynamiclinks/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/firebasedynamiclinks/webpack.config.js b/src/apis/firebasedynamiclinks/webpack.config.js index 6e1692a0d8d..4df1a122bb8 100644 --- a/src/apis/firebasedynamiclinks/webpack.config.js +++ b/src/apis/firebasedynamiclinks/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/firebasehosting/package.json b/src/apis/firebasehosting/package.json index 494b3ad0620..e579316cc45 100644 --- a/src/apis/firebasehosting/package.json +++ b/src/apis/firebasehosting/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/firebasehosting/webpack.config.js b/src/apis/firebasehosting/webpack.config.js index 40edadbc853..d004819ec06 100644 --- a/src/apis/firebasehosting/webpack.config.js +++ b/src/apis/firebasehosting/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/firebaserules/package.json b/src/apis/firebaserules/package.json index 75468b046a6..d25bea7eda9 100644 --- a/src/apis/firebaserules/package.json +++ b/src/apis/firebaserules/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/firebaserules/webpack.config.js b/src/apis/firebaserules/webpack.config.js index fa516062b99..a37bda6ae76 100644 --- a/src/apis/firebaserules/webpack.config.js +++ b/src/apis/firebaserules/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/firestore/package.json b/src/apis/firestore/package.json index 3ceeadc839e..dc33f8fceb3 100644 --- a/src/apis/firestore/package.json +++ b/src/apis/firestore/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/firestore/webpack.config.js b/src/apis/firestore/webpack.config.js index 0e9e0017d9c..212e55e30aa 100644 --- a/src/apis/firestore/webpack.config.js +++ b/src/apis/firestore/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/fitness/package.json b/src/apis/fitness/package.json index c3f5703d804..93f1e1c59f8 100644 --- a/src/apis/fitness/package.json +++ b/src/apis/fitness/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/fitness/v1.ts b/src/apis/fitness/v1.ts index cdc1d42a2d6..295a8f5b9e8 100644 --- a/src/apis/fitness/v1.ts +++ b/src/apis/fitness/v1.ts @@ -169,7 +169,7 @@ export namespace fitness_v1 { */ endTimeMillis?: string; /** - * DO NOT POPULATE THIS FIELD. As data quality standards are deprecated, filling it in will result in no data sources being returned. It will be removed in a future version entirely. + * DO NOT POPULATE THIS FIELD. It is ignored. */ filteredDataQualityStandard?: string[]; /** diff --git a/src/apis/fitness/webpack.config.js b/src/apis/fitness/webpack.config.js index 51039488dce..2569a0fcd83 100644 --- a/src/apis/fitness/webpack.config.js +++ b/src/apis/fitness/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/fusiontables/package.json b/src/apis/fusiontables/package.json index 248fc736e97..f88bfc9ba0c 100644 --- a/src/apis/fusiontables/package.json +++ b/src/apis/fusiontables/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/fusiontables/webpack.config.js b/src/apis/fusiontables/webpack.config.js index 346cf82fb97..a9694d852ed 100644 --- a/src/apis/fusiontables/webpack.config.js +++ b/src/apis/fusiontables/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/games/package.json b/src/apis/games/package.json index 500d40fa1a9..3ac28e0975d 100644 --- a/src/apis/games/package.json +++ b/src/apis/games/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/games/webpack.config.js b/src/apis/games/webpack.config.js index 0a860a38fb3..7afb8ba2ce1 100644 --- a/src/apis/games/webpack.config.js +++ b/src/apis/games/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/gamesConfiguration/package.json b/src/apis/gamesConfiguration/package.json index 1e829d2c21e..70ca2cc0ab9 100644 --- a/src/apis/gamesConfiguration/package.json +++ b/src/apis/gamesConfiguration/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/gamesConfiguration/webpack.config.js b/src/apis/gamesConfiguration/webpack.config.js index f3fa91e7208..0f5a84485e5 100644 --- a/src/apis/gamesConfiguration/webpack.config.js +++ b/src/apis/gamesConfiguration/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/gamesManagement/package.json b/src/apis/gamesManagement/package.json index 90d5049ba81..c1263891a3a 100644 --- a/src/apis/gamesManagement/package.json +++ b/src/apis/gamesManagement/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/gamesManagement/webpack.config.js b/src/apis/gamesManagement/webpack.config.js index 514af405b32..2f7c8d75b6d 100644 --- a/src/apis/gamesManagement/webpack.config.js +++ b/src/apis/gamesManagement/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/genomics/package.json b/src/apis/genomics/package.json index c99b09db85c..346a2e026df 100644 --- a/src/apis/genomics/package.json +++ b/src/apis/genomics/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/genomics/v1.ts b/src/apis/genomics/v1.ts index 15806215427..8b9342620fe 100644 --- a/src/apis/genomics/v1.ts +++ b/src/apis/genomics/v1.ts @@ -360,7 +360,7 @@ export namespace genomics_v1 { computeEngine?: Schema$ComputeEngine; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -440,7 +440,7 @@ export namespace genomics_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var genomics = google.genomics('v1'); * * authorize(function(authClient) { @@ -464,16 +464,12 @@ export namespace genomics_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias genomics.operations.cancel @@ -561,7 +557,7 @@ export namespace genomics_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var genomics = google.genomics('v1'); * * authorize(function(authClient) { @@ -584,16 +580,12 @@ export namespace genomics_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias genomics.operations.get @@ -681,7 +673,7 @@ export namespace genomics_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var genomics = google.genomics('v1'); * * authorize(function(authClient) { @@ -717,16 +709,12 @@ export namespace genomics_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias genomics.operations.list diff --git a/src/apis/genomics/v1alpha2.ts b/src/apis/genomics/v1alpha2.ts index 22c0c2cfaa6..e4332259e44 100644 --- a/src/apis/genomics/v1alpha2.ts +++ b/src/apis/genomics/v1alpha2.ts @@ -639,7 +639,7 @@ export namespace genomics_v1alpha2 { validationToken?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -732,7 +732,7 @@ export namespace genomics_v1alpha2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var genomics = google.genomics('v1alpha2'); * * authorize(function(authClient) { @@ -756,16 +756,12 @@ export namespace genomics_v1alpha2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias genomics.operations.cancel @@ -856,7 +852,7 @@ export namespace genomics_v1alpha2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var genomics = google.genomics('v1alpha2'); * * authorize(function(authClient) { @@ -879,16 +875,12 @@ export namespace genomics_v1alpha2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias genomics.operations.get @@ -976,7 +968,7 @@ export namespace genomics_v1alpha2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var genomics = google.genomics('v1alpha2'); * * authorize(function(authClient) { @@ -1012,16 +1004,12 @@ export namespace genomics_v1alpha2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias genomics.operations.list @@ -1173,7 +1161,7 @@ export namespace genomics_v1alpha2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var genomics = google.genomics('v1alpha2'); * * authorize(function(authClient) { @@ -1197,16 +1185,12 @@ export namespace genomics_v1alpha2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias genomics.pipelines.create @@ -1295,7 +1279,7 @@ export namespace genomics_v1alpha2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var genomics = google.genomics('v1alpha2'); * * authorize(function(authClient) { @@ -1316,16 +1300,12 @@ export namespace genomics_v1alpha2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias genomics.pipelines.delete @@ -1414,7 +1394,7 @@ export namespace genomics_v1alpha2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var genomics = google.genomics('v1alpha2'); * * authorize(function(authClient) { @@ -1438,16 +1418,12 @@ export namespace genomics_v1alpha2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias genomics.pipelines.get @@ -1536,7 +1512,7 @@ export namespace genomics_v1alpha2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var genomics = google.genomics('v1alpha2'); * * authorize(function(authClient) { @@ -1556,16 +1532,12 @@ export namespace genomics_v1alpha2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias genomics.pipelines.getControllerConfig @@ -1660,7 +1632,7 @@ export namespace genomics_v1alpha2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var genomics = google.genomics('v1alpha2'); * * authorize(function(authClient) { @@ -1693,16 +1665,12 @@ export namespace genomics_v1alpha2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias genomics.pipelines.list @@ -1798,7 +1766,7 @@ export namespace genomics_v1alpha2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var genomics = google.genomics('v1alpha2'); * * authorize(function(authClient) { @@ -1822,16 +1790,12 @@ export namespace genomics_v1alpha2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias genomics.pipelines.run @@ -1922,7 +1886,7 @@ export namespace genomics_v1alpha2 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var genomics = google.genomics('v1alpha2'); * * authorize(function(authClient) { @@ -1944,16 +1908,12 @@ export namespace genomics_v1alpha2 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias genomics.pipelines.setOperationStatus diff --git a/src/apis/genomics/v2alpha1.ts b/src/apis/genomics/v2alpha1.ts index 7bfd9bbfa59..af135b4e802 100644 --- a/src/apis/genomics/v2alpha1.ts +++ b/src/apis/genomics/v2alpha1.ts @@ -171,7 +171,7 @@ export namespace genomics_v2alpha1 { */ mounts?: Schema$Mount[]; /** - * An optional name for the container. The container hostname will be set to this name, making it useful for inter-container communication. The name must contain only upper and lowercase alphanumeric characters and hypens and cannot start with a hypen. + * An optional name for the container. The container hostname will be set to this name, making it useful for inter-container communication. The name must contain only upper and lowercase alphanumeric characters and hypens and cannot start with a hyphen. */ name?: string; /** @@ -307,7 +307,7 @@ export namespace genomics_v2alpha1 { */ export interface Schema$Disk { /** - * A user-supplied name for the disk. Used when mounting the disk into actions. The name must contain only upper and lowercase alphanumeric characters and hypens and cannot start with a hypen. + * A user-supplied name for the disk. Used when mounting the disk into actions. The name must contain only upper and lowercase alphanumeric characters and hypens and cannot start with a hyphen. */ name?: string; /** @@ -642,7 +642,7 @@ export namespace genomics_v2alpha1 { scopes?: string[]; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -700,7 +700,7 @@ export namespace genomics_v2alpha1 { */ enableStackdriverMonitoring?: boolean; /** - * Optional set of labels to apply to the VM and any attached disk resources. These labels must adhere to the name and value restrictions on VM labels imposed by Compute Engine. Labels applied at creation time to the VM. Applied on a best-effort basis to attached disk resources shortly after VM creation. + * Optional set of labels to apply to the VM and any attached disk resources. These labels must adhere to the name and value restrictions on VM labels imposed by Compute Engine. Labels keys with the prefix 'google-' are reserved for use by Google. Labels applied at creation time to the VM. Applied on a best-effort basis to attached disk resources shortly after VM creation. */ labels?: {[key: string]: string}; /** @@ -785,6 +785,53 @@ export namespace genomics_v2alpha1 { /** * genomics.pipelines.run * @desc Runs a pipeline. **Note:** Before you can use this method, the Genomics Service Agent must have access to your project. This is done automatically when the Cloud Genomics API is first enabled, but if you delete this permission, or if you enabled the Cloud Genomics API before the v2alpha1 API launch, you must disable and re-enable the API to grant the Genomics Service Agent the required permissions. Authorization requires the following [Google IAM](https://cloud.google.com/iam/) permission: * `genomics.operations.create` [1]: /genomics/gsa + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Genomics API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/genomics + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var genomics = google.genomics('v2alpha1'); + * + * authorize(function(authClient) { + * var request = { + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * genomics.pipelines.run(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias genomics.pipelines.run * @memberOf! () * @@ -886,6 +933,53 @@ export namespace genomics_v2alpha1 { /** * genomics.projects.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. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel` + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Genomics API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/genomics + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var genomics = google.genomics('v2alpha1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/operations/my-operation', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * genomics.projects.operations.cancel(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias genomics.projects.operations.cancel * @memberOf! () * @@ -959,6 +1053,52 @@ export namespace genomics_v2alpha1 { /** * genomics.projects.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. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get` + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Genomics API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/genomics + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var genomics = google.genomics('v2alpha1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the operation resource. + * name: 'projects/my-project/operations/my-operation', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * genomics.projects.operations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias genomics.projects.operations.get * @memberOf! () * @@ -1030,6 +1170,65 @@ export namespace genomics_v2alpha1 { /** * genomics.projects.operations.list * @desc Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list` + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Genomics API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/genomics + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var genomics = google.genomics('v2alpha1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the operation's parent resource. + * name: 'projects/my-project/operations', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var operationsPage = response['operations']; + * if (!operationsPage) { + * return; + * } + * for (var i = 0; i < operationsPage.length; i++) { + * // TODO: Change code below to process each resource in `operationsPage`: + * console.log(JSON.stringify(operationsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * genomics.projects.operations.list(request, handlePage); + * } + * }; + * + * genomics.projects.operations.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias genomics.projects.operations.list * @memberOf! () * @@ -1167,6 +1366,56 @@ export namespace genomics_v2alpha1 { /** * genomics.workers.checkIn * @desc The worker uses this method to retrieve the assigned operation and provide periodic status updates. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Genomics API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/genomics + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var genomics = google.genomics('v2alpha1'); + * + * authorize(function(authClient) { + * var request = { + * // The worker id, assigned when it was created. + * id: 'my-id', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * genomics.workers.checkIn(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias genomics.workers.checkIn * @memberOf! () * diff --git a/src/apis/genomics/webpack.config.js b/src/apis/genomics/webpack.config.js index ed9b4960e3b..1d59a7a546b 100644 --- a/src/apis/genomics/webpack.config.js +++ b/src/apis/genomics/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/gmail/package.json b/src/apis/gmail/package.json index 970c09d3270..5833aa5bcaf 100644 --- a/src/apis/gmail/package.json +++ b/src/apis/gmail/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/gmail/v1.ts b/src/apis/gmail/v1.ts index 5d21032c8db..169d43d65e4 100644 --- a/src/apis/gmail/v1.ts +++ b/src/apis/gmail/v1.ts @@ -369,11 +369,11 @@ export namespace gmail_v1 { } export interface Schema$LabelColor { /** - * The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c + * The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 */ backgroundColor?: string; /** - * The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c + * The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 */ textColor?: string; } diff --git a/src/apis/gmail/webpack.config.js b/src/apis/gmail/webpack.config.js index c686a7dd6f5..f82e7303411 100644 --- a/src/apis/gmail/webpack.config.js +++ b/src/apis/gmail/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/groupsmigration/package.json b/src/apis/groupsmigration/package.json index 65bb0d097fa..edd6a3cf9b2 100644 --- a/src/apis/groupsmigration/package.json +++ b/src/apis/groupsmigration/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/groupsmigration/webpack.config.js b/src/apis/groupsmigration/webpack.config.js index 14c893c9450..dfbc3c98b96 100644 --- a/src/apis/groupsmigration/webpack.config.js +++ b/src/apis/groupsmigration/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/groupssettings/package.json b/src/apis/groupssettings/package.json index f05de528e8f..c984da8a379 100644 --- a/src/apis/groupssettings/package.json +++ b/src/apis/groupssettings/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/groupssettings/webpack.config.js b/src/apis/groupssettings/webpack.config.js index e0dd2bbb195..8b6129e4efc 100644 --- a/src/apis/groupssettings/webpack.config.js +++ b/src/apis/groupssettings/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/healthcare/package.json b/src/apis/healthcare/package.json index 5476eb71ffb..cee56330d2b 100644 --- a/src/apis/healthcare/package.json +++ b/src/apis/healthcare/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/healthcare/v1alpha2.ts b/src/apis/healthcare/v1alpha2.ts index 6725d48f4c0..924b87eb47b 100644 --- a/src/apis/healthcare/v1alpha2.ts +++ b/src/apis/healthcare/v1alpha2.ts @@ -138,7 +138,7 @@ export namespace healthcare_v1alpha2 { */ resourceAnnotation?: Schema$ResourceAnnotation; /** - * Annotations for sentitive texts, e.g., range of such texts. + * Annotations for sensitive texts, e.g., range of such texts. */ textAnnotation?: Schema$SensitiveTextAnnotation; } @@ -165,7 +165,7 @@ export namespace healthcare_v1alpha2 { name?: string; } /** - * 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. + * 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:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -178,13 +178,17 @@ export namespace healthcare_v1alpha2 { 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. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.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[]; + /** + * Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored. + */ + ignoreChildExemptions?: boolean; /** * The log type that this config enables. */ @@ -199,7 +203,7 @@ export namespace healthcare_v1alpha2 { */ 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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * 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@example.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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** @@ -402,7 +406,7 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$ExportDicomDataRequest { /** - * The BigQuery output destination. For now, only exporting to a dataset in the current project is supported The BigQuery location requires two IAM roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. + * The BigQuery output destination. You can only export to a BigQuery dataset that's in the same project as the DICOM store you're exporting from. The BigQuery location requires two IAM roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. */ bigqueryDestination?: Schema$GoogleCloudHealthcareV1alpha2DicomBigQueryDestination; /** @@ -485,6 +489,18 @@ export namespace healthcare_v1alpha2 { * If non-empty, publish all resource modifications of this FHIR store to this destination. The Cloud Pub/Sub message attributes will contain a map with a string describing the action that has triggered the notification, e.g. "action":"CreateResource". */ notificationConfig?: Schema$NotificationConfig; + /** + * A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation will be streamed to the new location in addition to the existing ones. When a location is removed from the list, the server will simply stop streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. + */ + streamConfigs?: Schema$StreamConfig[]; + /** + * Configuration of FHIR Subscription: https://www.hl7.org/fhir/subscription.html. + */ + subscriptionConfig?: Schema$SubscriptionConfig; + /** + * Configuration for how incoming FHIR resources will be validated against configured profiles. + */ + validationConfig?: Schema$ValidationConfig; } /** * Specifies FHIR paths to match, and how to handle de-identification of matching fields. @@ -516,7 +532,21 @@ export namespace healthcare_v1alpha2 { /** * Request message for `GetIamPolicy` method. */ - export interface Schema$GetIamPolicyRequest {} + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + */ + options?: Schema$GetPolicyOptions; + } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + requestedPolicyVersion?: number; + } /** * The BigQuery table where the output should be written. */ @@ -718,7 +748,7 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$ImportResourcesRequest { /** - * The content structure in the source location. The default is BUNDLE. + * The content structure in the source location. If not specified, the server treats the input source files as BUNDLE. */ contentStructure?: string; /** @@ -726,7 +756,7 @@ export namespace healthcare_v1alpha2 { */ gcsErrorDestination?: Schema$GoogleCloudHealthcareV1alpha2FhirRestGcsErrorDestination; /** - * Cloud Storage source data location and import configuration. The Cloud Storage location requires the `roles/storage.objectViewer` Cloud IAM role. Each Cloud Storage object should be a text file that contains newline delimited JSON structures conforming to FHIR standard. To improve performance, use multiple Cloud Storage objects where each object contains a subset of all of the newline-delimited JSON structures. You can select all of the objects using the uri as the prefix. The maximum number of objects is 1,000. + * Cloud Storage source data location and import configuration. The Cloud Storage location requires the `roles/storage.objectViewer` Cloud IAM role. Each Cloud Storage object should be a text file that contains the format specified in ContentStructu. */ gcsSource?: Schema$GoogleCloudHealthcareV1alpha2FhirRestGcsSource; } @@ -928,7 +958,7 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$Message { /** - * The datetime when the message was created. Set by the server. + * Output only. The datetime when the message was created. Set by the server. */ createTime?: string; /** @@ -948,7 +978,7 @@ export namespace healthcare_v1alpha2 { */ name?: string; /** - * The parsed version of the raw message data. + * Output only. The parsed version of the raw message data. */ parsedData?: Schema$ParsedData; /** @@ -1031,7 +1061,7 @@ export namespace healthcare_v1alpha2 { */ allowNullHeader?: boolean; /** - * Byte(s) to be used as the segment terminator. If this is unset, '\r' will be used as segment terminator. + * Byte(s) to be used as the segment terminator. If this is unset, '\r' will be used as the segment terminator, matching the HL7 version 2 specification. */ segmentTerminator?: string; } @@ -1061,7 +1091,7 @@ export namespace healthcare_v1alpha2 { */ 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` 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. */ etag?: string; /** @@ -1101,7 +1131,7 @@ export namespace healthcare_v1alpha2 { label?: string; } /** - * Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. + * Configuration for the FHIR BigQuery and Cloud Storage schema. Determines how the server generates the schema. */ export interface Schema$SchemaConfig { /** @@ -1162,7 +1192,7 @@ export namespace healthcare_v1alpha2 { updateMask?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -1178,6 +1208,41 @@ export namespace healthcare_v1alpha2 { */ message?: string; } + /** + * This structure contains configuration for streaming FHIR export. + */ + export interface Schema$StreamConfig { + /** + * The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output will be organized in one table per resource type. The server will inspect and potentially create new tables (if they don't exist) in the given BigQuery dataset. Results will be appended to the corresponding BigQuery tables. The views of the latest snapshot will also be automatically created in the dataset. + */ + bigqueryDestination?: Schema$GoogleCloudHealthcareV1alpha2FhirBigQueryDestination; + /** + * Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server will treat an empty list as an intent to stream all the supported resource types in this FHIR store. + */ + resourceTypes?: string[]; + } + /** + * Configuration of FHIR Subscription: https://www.hl7.org/fhir/subscription.html. + */ + export interface Schema$SubscriptionConfig { + /** + * REST hook endpoints that are allowed to receive subscription notifications. The create or update operation on a FHIR Subscription resource will fail if the FHIR Subscription resource contains a REST hook endpoint that is not in this list. A subscription notification push will fail if the FHIR Subscription resource contains a REST hook endpoint that is not in this list. The REST hook endpoint in a subscription resource will be compared with the endpoints in this list by exact matching. Users must verify their ownership of the domain of an endpoint before adding it to this list. To verify domain ownership, go to https://search.google.com/search-console/welcome. + */ + allowedRestHookEndpoints?: Schema$SubscriptionRestHookEndpoint[]; + } + /** + * REST hook endpoint of FHIR Subscription. + */ + export interface Schema$SubscriptionRestHookEndpoint { + /** + * Whether this endpoint is allowed to receive full resource payloads. If set to false, the subscription notificiation sending to this endpoint with full resource payload will be blocked. + */ + allowResourcePayload?: boolean; + /** + * Address of the REST hook endpoint. It must be a valid HTTPS URL with TLS certificate. + */ + endpoint?: string; + } /** * List of tags to be filtered. */ @@ -1215,6 +1280,19 @@ export namespace healthcare_v1alpha2 { */ transformations?: Schema$InfoTypeTransformation[]; } + /** + * This structure contains the configuration for FHIR profiles and validation. + */ + export interface Schema$ValidationConfig { + /** + * Whether profile validation should be disabled for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. + */ + disableProfileValidation?: boolean; + /** + * A list of ImplementationGuide IDs in this FHIR store that will be used to configure which profiles are used for validation. For example, to enable an implementation guide with ID 1 set `enabled_implementation_guides` to `["1"]`. If `enabled_implementation_guides` is empty or omitted then incoming resources will only be required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. + */ + enabledImplementationGuides?: string[]; + } /** * A 2D coordinate in an image. The origin is the top-left. */ @@ -1460,7 +1538,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.create - * @desc Creates a new health dataset. Results are returned through the Operation interface which returns either an `Operation.response` which contains a Dataset or `Operation.error`. The metadata field type is OperationMetadata. + * @desc Creates a new health dataset. Results are returned through the Operation interface which returns either an `Operation.response` which contains a Dataset or `Operation.error`. The metadata field type is OperationMetadata. A Google Cloud Platform project can contain up to 500 datasets across all regions. * @alias healthcare.projects.locations.datasets.create * @memberOf! () * @@ -1754,6 +1832,7 @@ export namespace healthcare_v1alpha2 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2193,6 +2272,10 @@ export namespace healthcare_v1alpha2 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ @@ -2734,7 +2817,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.annotationStores.setIamPolicy - * @desc POLICIES Sets the access control policy for a resource. Replaces any existing policy. Authorization requires the Google IAM permission 'healthcare.annotationStores.setIamPolicy' on the specified resource + * @desc POLICIES Sets the access control policy for a resource. Replaces any existing policy. Authorization requires the Google IAM permission `healthcare.annotationStores.setIamPolicy` on the specified resource * @alias healthcare.projects.locations.datasets.annotationStores.setIamPolicy * @memberOf! () * @@ -3799,6 +3882,7 @@ export namespace healthcare_v1alpha2 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4316,6 +4400,10 @@ export namespace healthcare_v1alpha2 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ @@ -4430,12 +4518,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForInstances - * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForInstances * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). + * @param {string} params.dicomWebPath The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4502,12 +4590,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForSeries - * @desc SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @desc SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForSeries * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `series`). + * @param {string} params.dicomWebPath The path of the SearchForSeries DICOMweb request(e.g., `series` or `studies/{study_uid}/series`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4574,12 +4662,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForStudies - * @desc SearchForStudies returns a list of matching studies. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @desc SearchForStudies returns a list of matching studies. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.searchForStudies * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies`). + * @param {string} params.dicomWebPath The path of the SearchForStudies DICOMweb request (e.g., `studies`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4646,12 +4734,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.storeInstances - * @desc StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1. + * @desc StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.storeInstances * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). + * @param {string} params.dicomWebPath The path of the StoreInstances DICOMweb request (e.g., `studies/[{study_id}]`). Note that the `study_uid` is optional. * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {().HttpBody} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4726,7 +4814,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). + * The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). */ dicomWebPath?: string; /** @@ -4742,7 +4830,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `series`). + * The path of the SearchForSeries DICOMweb request(e.g., `series` or `studies/{study_uid}/series`). */ dicomWebPath?: string; /** @@ -4758,7 +4846,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies`). + * The path of the SearchForStudies DICOMweb request (e.g., `studies`). */ dicomWebPath?: string; /** @@ -4774,7 +4862,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). + * The path of the StoreInstances DICOMweb request (e.g., `studies/[{study_id}]`). Note that the `study_uid` is optional. */ dicomWebPath?: string; /** @@ -4805,7 +4893,7 @@ export namespace healthcare_v1alpha2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). + * @param {string} params.dicomWebPath The path of the DeleteStudy request (e.g., `studies/{study_id}`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4872,12 +4960,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.metadata - * @desc RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. + * @desc RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.metadata * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/metadata`. + * @param {string} params.dicomWebPath The path of the RetrieveStudyMetadata DICOMweb request (e.g., `studies/{study_id}/metadata`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4944,12 +5032,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.retrieveStudy - * @desc RetrieveStudy returns all instances within the given study. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.1. + * @desc RetrieveStudy returns all instances within the given study. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.retrieveStudy * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). + * @param {string} params.dicomWebPath The path of the RetrieveStudy DICOMweb request (e.g., `studies/{study_id}`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5016,12 +5104,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.searchForInstances - * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.searchForInstances * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). + * @param {string} params.dicomWebPath The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5088,12 +5176,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.searchForSeries - * @desc SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @desc SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.searchForSeries * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `series`). + * @param {string} params.dicomWebPath The path of the SearchForSeries DICOMweb request(e.g., `series` or `studies/{study_uid}/series`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5160,12 +5248,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.storeInstances - * @desc StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1. + * @desc StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.storeInstances * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). + * @param {string} params.dicomWebPath The path of the StoreInstances DICOMweb request (e.g., `studies/[{study_id}]`). Note that the `study_uid` is optional. * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {().HttpBody} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5240,7 +5328,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). + * The path of the DeleteStudy request (e.g., `studies/{study_id}`). */ dicomWebPath?: string; /** @@ -5256,7 +5344,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/metadata`. + * The path of the RetrieveStudyMetadata DICOMweb request (e.g., `studies/{study_id}/metadata`). */ dicomWebPath?: string; /** @@ -5272,7 +5360,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). + * The path of the RetrieveStudy DICOMweb request (e.g., `studies/{study_id}`). */ dicomWebPath?: string; /** @@ -5288,7 +5376,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). + * The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). */ dicomWebPath?: string; /** @@ -5304,7 +5392,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `series`). + * The path of the SearchForSeries DICOMweb request(e.g., `series` or `studies/{study_uid}/series`). */ dicomWebPath?: string; /** @@ -5320,7 +5408,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). + * The path of the StoreInstances DICOMweb request (e.g., `studies/[{study_id}]`). Note that the `study_uid` is optional. */ dicomWebPath?: string; /** @@ -5351,7 +5439,7 @@ export namespace healthcare_v1alpha2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}`). + * @param {string} params.dicomWebPath The path of the DeleteSeries request (e.g., `studies/{study_id}/series/{series_id}`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5418,12 +5506,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.metadata - * @desc RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. + * @desc RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.metadata * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/metadata`. + * @param {string} params.dicomWebPath The path of the RetrieveSeriesMetadata DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/metadata`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5490,12 +5578,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.retrieveSeries - * @desc RetrieveSeries returns all instances within the given study and series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.2. + * @desc RetrieveSeries returns all instances within the given study and series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.retrieveSeries * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}`). + * @param {string} params.dicomWebPath The path of the RetrieveSeries DICOMweb request (e.g., `studies/{study_id}/series/{series_id}`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5562,12 +5650,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.searchForInstances - * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.searchForInstances * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). + * @param {string} params.dicomWebPath The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5641,7 +5729,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}`). + * The path of the DeleteSeries request (e.g., `studies/{study_id}/series/{series_id}`). */ dicomWebPath?: string; /** @@ -5657,7 +5745,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/metadata`. + * The path of the RetrieveSeriesMetadata DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/metadata`). */ dicomWebPath?: string; /** @@ -5673,7 +5761,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}`). + * The path of the RetrieveSeries DICOMweb request (e.g., `studies/{study_id}/series/{series_id}`). */ dicomWebPath?: string; /** @@ -5689,7 +5777,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). + * The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). */ dicomWebPath?: string; /** @@ -5715,7 +5803,7 @@ export namespace healthcare_v1alpha2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). + * @param {string} params.dicomWebPath The path of the DeleteInstance request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5782,12 +5870,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.metadata - * @desc RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. + * @desc RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.metadata * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). + * @param {string} params.dicomWebPath The path of the RetrieveInstanceMetadata DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5854,12 +5942,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.rendered - * @desc RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8. + * @desc RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.rendered * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/rendered`). + * @param {string} params.dicomWebPath The path of the RetrieveRenderedInstance DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/rendered`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5926,12 +6014,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.retrieveInstance - * @desc RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.3. + * @desc RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.retrieveInstance * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}`). + * @param {string} params.dicomWebPath The path of the RetrieveInstance DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6005,7 +6093,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). + * The path of the DeleteInstance request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). */ dicomWebPath?: string; /** @@ -6021,7 +6109,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). + * The path of the RetrieveInstanceMetadata DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). */ dicomWebPath?: string; /** @@ -6037,7 +6125,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/rendered`). + * The path of the RetrieveRenderedInstance DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/rendered`). */ dicomWebPath?: string; /** @@ -6053,7 +6141,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}`). + * The path of the RetrieveInstance DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). */ dicomWebPath?: string; /** @@ -6070,12 +6158,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.frames.rendered - * @desc RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8. + * @desc RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.frames.rendered * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}/rendered`). + * @param {string} params.dicomWebPath The path of the RetrieveRenderedFrames DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}/rendered`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6142,12 +6230,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.frames.retrieveFrames - * @desc RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.4. + * @desc RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. * @alias healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.frames.retrieveFrames * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}`). + * @param {string} params.dicomWebPath The path of the RetrieveFrames DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6221,7 +6309,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}/rendered`). + * The path of the RetrieveRenderedFrames DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}/rendered`). */ dicomWebPath?: string; /** @@ -6237,7 +6325,7 @@ export namespace healthcare_v1alpha2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}`). + * The path of the RetrieveFrames DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}`). */ dicomWebPath?: string; /** @@ -6625,11 +6713,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.fhirStores.getIamPolicy - * @desc Gets the access control policy for a FHIR store or security label within a FHIR store. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set. Authorization requires the Google IAM permission 'healthcare.fhirStores.getIamPolicy' for a FHIR store or 'healthcare.securityLabels.getIamPolicy' for a security label + * @desc Gets the access control policy for a FHIR store or security label within a FHIR store. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set. Authorization requires the Google IAM permission `healthcare.fhirStores.getIamPolicy` for a FHIR store or `healthcare.securityLabels.getIamPolicy` for a security label * @alias healthcare.projects.locations.datasets.fhirStores.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6924,7 +7013,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.fhirStores.setIamPolicy - * @desc Sets the access control policy for a FHIR store or security label within a FHIR store. Replaces any existing policy. Authorization requires the Google IAM permission 'healthcare.fhirStores.setIamPolicy' for a FHIR store or 'healthcare.securityLabels.setIamPolicy' for a security label + * @desc Sets the access control policy for a FHIR store or security label within a FHIR store. Replaces any existing policy. Authorization requires the Google IAM permission `healthcare.fhirStores.setIamPolicy` for a FHIR store or `healthcare.securityLabels.setIamPolicy` for a security label * @alias healthcare.projects.locations.datasets.fhirStores.setIamPolicy * @memberOf! () * @@ -7159,6 +7248,10 @@ export namespace healthcare_v1alpha2 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ @@ -8210,7 +8303,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.search - * @desc Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard [search interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#search) using the search semantics described in the [FHIR Search specification](http://hl7.org/implement/standards/fhir/STU3/search.html). Supports three methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method. The `GET` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. # Search Parameters The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the [FHIR Search Parameter Registry](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html). # Search Modifiers Modifier | Supported ----------- | --------- `:missing` | Yes `:exact` | Yes `:contains` | Yes `:text` | Yes `:in` | Yes `:not-in` | Yes `:above` | Yes `:below` | Yes `:[type]` | Yes `:not` | Yes `:recurse` | No + * @desc Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard [search interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#search) using the search semantics described in the [FHIR Search specification](http://hl7.org/implement/standards/fhir/STU3/search.html). Supports three methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method. The `GET` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the [FHIR Search Parameter Registry](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html). Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` will contain pagination links. * @alias healthcare.projects.locations.datasets.fhirStores.fhir.search * @memberOf! () * @@ -8697,11 +8790,12 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.fhirStores.securityLabels.getIamPolicy - * @desc Gets the access control policy for a FHIR store or security label within a FHIR store. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set. Authorization requires the Google IAM permission 'healthcare.fhirStores.getIamPolicy' for a FHIR store or 'healthcare.securityLabels.getIamPolicy' for a security label + * @desc Gets the access control policy for a FHIR store or security label within a FHIR store. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set. Authorization requires the Google IAM permission `healthcare.fhirStores.getIamPolicy` for a FHIR store or `healthcare.securityLabels.getIamPolicy` for a security label * @alias healthcare.projects.locations.datasets.fhirStores.securityLabels.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8769,7 +8863,7 @@ export namespace healthcare_v1alpha2 { /** * healthcare.projects.locations.datasets.fhirStores.securityLabels.setIamPolicy - * @desc Sets the access control policy for a FHIR store or security label within a FHIR store. Replaces any existing policy. Authorization requires the Google IAM permission 'healthcare.fhirStores.setIamPolicy' for a FHIR store or 'healthcare.securityLabels.setIamPolicy' for a security label + * @desc Sets the access control policy for a FHIR store or security label within a FHIR store. Replaces any existing policy. Authorization requires the Google IAM permission `healthcare.fhirStores.setIamPolicy` for a FHIR store or `healthcare.securityLabels.setIamPolicy` for a security label * @alias healthcare.projects.locations.datasets.fhirStores.securityLabels.setIamPolicy * @memberOf! () * @@ -8848,6 +8942,10 @@ export namespace healthcare_v1alpha2 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ @@ -9104,6 +9202,7 @@ export namespace healthcare_v1alpha2 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9529,6 +9628,10 @@ export namespace healthcare_v1alpha2 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ diff --git a/src/apis/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index 50ec6494add..c6a622c8606 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -118,7 +118,7 @@ export namespace healthcare_v1beta1 { } /** - * 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. + * 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:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -131,13 +131,17 @@ export namespace healthcare_v1beta1 { 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. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.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[]; + /** + * Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored. + */ + ignoreChildExemptions?: boolean; /** * The log type that this config enables. */ @@ -152,7 +156,7 @@ export namespace healthcare_v1beta1 { */ 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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * 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@example.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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** @@ -333,7 +337,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$ExportDicomDataRequest { /** - * The BigQuery output destination. For now, only exporting to a dataset in the current project is supported The BigQuery location requires two IAM roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. + * The BigQuery output destination. You can only export to a BigQuery dataset that's in the same project as the DICOM store you're exporting from. The BigQuery location requires two IAM roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. */ bigqueryDestination?: Schema$GoogleCloudHealthcareV1beta1DicomBigQueryDestination; /** @@ -613,11 +617,11 @@ export namespace healthcare_v1beta1 { */ export interface Schema$ImportResourcesRequest { /** - * The content structure in the source location. The default is BUNDLE. + * The content structure in the source location. If not specified, the server treats the input source files as BUNDLE. */ contentStructure?: string; /** - * Cloud Storage source data location and import configuration. The Cloud Storage location requires the `roles/storage.objectViewer` Cloud IAM role. Each Cloud Storage object should be a text file that contains newline delimited JSON structures conforming to FHIR standard. To improve performance, use multiple Cloud Storage objects where each object contains a subset of all of the newline-delimited JSON structures. You can select all of the objects using the uri as the prefix. The maximum number of objects is 1,000. + * Cloud Storage source data location and import configuration. The Cloud Storage location requires the `roles/storage.objectViewer` Cloud IAM role. Each Cloud Storage object should be a text file that contains the format specified in ContentStructure. */ gcsSource?: Schema$GoogleCloudHealthcareV1beta1FhirRestGcsSource; } @@ -793,7 +797,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$Message { /** - * The datetime when the message was created. Set by the server. + * Output only. The datetime when the message was created. Set by the server. */ createTime?: string; /** @@ -813,7 +817,7 @@ export namespace healthcare_v1beta1 { */ name?: string; /** - * The parsed version of the raw message data. + * Output only. The parsed version of the raw message data. */ parsedData?: Schema$ParsedData; /** @@ -926,7 +930,7 @@ export namespace healthcare_v1beta1 { */ 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` 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. */ etag?: string; /** @@ -1012,7 +1016,7 @@ export namespace healthcare_v1beta1 { updateMask?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -1082,6 +1086,52 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.get * @desc Gets information about a location. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Resource name for the location. + * name: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.get * @memberOf! () * @@ -1151,6 +1201,65 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.list * @desc Lists information about the supported locations for this service. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource that owns the locations collection, if applicable. + * name: 'projects/my-project', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var locationsPage = response['locations']; + * if (!locationsPage) { + * return; + * } + * for (var i = 0; i < locationsPage.length; i++) { + * // TODO: Change code below to process each resource in `locationsPage`: + * console.log(JSON.stringify(locationsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudHealthcare.projects.locations.list(request, handlePage); + * } + * }; + * + * cloudHealthcare.projects.locations.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.list * @memberOf! () * @@ -1289,7 +1398,58 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.create - * @desc Creates a new health dataset. Results are returned through the Operation interface which returns either an `Operation.response` which contains a Dataset or `Operation.error`. The metadata field type is OperationMetadata. + * @desc Creates a new health dataset. Results are returned through the Operation interface which returns either an `Operation.response` which contains a Dataset or `Operation.error`. The metadata field type is OperationMetadata. A Google Cloud Platform project can contain up to 500 datasets across all regions. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the project in which the dataset should be created (e.g., + * // `projects/{project_id}/locations/{location_id}`). + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.create * @memberOf! () * @@ -1366,6 +1526,57 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.deidentify * @desc Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. If errors occur, details field type is DeidentifyErrorDetails. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Source dataset resource name. (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * sourceDataset: 'projects/my-project/locations/my-location/datasets/my-dataset', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.deidentify(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.deidentify * @memberOf! () * @@ -1441,6 +1652,50 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.delete * @desc Deletes the specified health dataset and all data contained in the dataset. Deleting a dataset does not affect the sources from which the dataset was imported (if any). + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the dataset to delete (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.delete * @memberOf! () * @@ -1510,6 +1765,53 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.get * @desc Gets any metadata associated with a dataset. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the dataset to read (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.get * @memberOf! () * @@ -1579,10 +1881,58 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/datasets/my-dataset', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1651,6 +2001,66 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.list * @desc Lists the health datasets in the current project. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the project whose datasets should be listed (e.g., + * // `projects/{project_id}/locations/{location_id}`). + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var datasetsPage = response['datasets']; + * if (!datasetsPage) { + * return; + * } + * for (var i = 0; i < datasetsPage.length; i++) { + * // TODO: Change code below to process each resource in `datasetsPage`: + * console.log(JSON.stringify(datasetsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudHealthcare.projects.locations.datasets.list(request, handlePage); + * } + * }; + * + * cloudHealthcare.projects.locations.datasets.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.list * @memberOf! () * @@ -1729,6 +2139,58 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.patch * @desc Updates dataset metadata. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Output only. Resource name of the dataset, of the form + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.patch * @memberOf! () * @@ -1800,6 +2262,57 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/datasets/my-dataset', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.setIamPolicy * @memberOf! () * @@ -1873,6 +2386,57 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/datasets/my-dataset', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.testIamPermissions * @memberOf! () * @@ -2022,6 +2586,10 @@ export namespace healthcare_v1beta1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ @@ -2116,6 +2684,56 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.create * @desc Creates a new DICOM store within the parent dataset. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the dataset this DICOM store belongs to. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.create * @memberOf! () * @@ -2192,6 +2810,49 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.delete * @desc Deletes the specified DICOM store and removes all images that are contained within it. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the DICOM store to delete. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.delete * @memberOf! () * @@ -2261,6 +2922,57 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.export * @desc Exports data to the specified destination by copying it from the DICOM store. The metadata field type is OperationMetadata. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The DICOM store resource name from which the data should be exported (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.export(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.export * @memberOf! () * @@ -2336,6 +3048,52 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.get * @desc Gets the specified DICOM store. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the DICOM store to get. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.get * @memberOf! () * @@ -2407,10 +3165,58 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2479,6 +3285,57 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.import * @desc Imports data into the DICOM store by copying it from the specified source. For errors, the Operation will be populated with error details (in the form of ImportDicomDataErrorDetails in error.details), which will hold finer-grained error information. The metadata field type is OperationMetadata. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store resource into which the data is imported (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.import(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.import * @memberOf! () * @@ -2554,6 +3411,65 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.list * @desc Lists the DICOM stores in the given dataset. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of the dataset. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var dicomStoresPage = response['dicomStores']; + * if (!dicomStoresPage) { + * return; + * } + * for (var i = 0; i < dicomStoresPage.length; i++) { + * // TODO: Change code below to process each resource in `dicomStoresPage`: + * console.log(JSON.stringify(dicomStoresPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudHealthcare.projects.locations.datasets.dicomStores.list(request, handlePage); + * } + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.list * @memberOf! () * @@ -2633,6 +3549,58 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.patch * @desc Updates the specified DICOM store. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Output only. Resource name of the DICOM store, of the form + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.patch * @memberOf! () * @@ -2705,12 +3673,64 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.searchForInstances - * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the SearchForInstancesRequest DICOMweb request (e.g., + * // `instances` or `series/{series_uid}/instances` or + * // `studies/{study_uid}/instances`). + * dicomWebPath: 'instances', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.searchForInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.searchForInstances * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). + * @param {string} params.dicomWebPath The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2777,12 +3797,63 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.searchForSeries - * @desc SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @desc SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the SearchForSeries DICOMweb request(e.g., `series` or + * // `studies/{study_uid}/series`). + * dicomWebPath: 'series', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.searchForSeries(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.searchForSeries * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `series`). + * @param {string} params.dicomWebPath The path of the SearchForSeries DICOMweb request(e.g., `series` or `studies/{study_uid}/series`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2849,12 +3920,62 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.searchForStudies - * @desc SearchForStudies returns a list of matching studies. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @desc SearchForStudies returns a list of matching studies. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the SearchForStudies DICOMweb request (e.g., `studies`). + * dicomWebPath: 'studies', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.searchForStudies(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.searchForStudies * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies`). + * @param {string} params.dicomWebPath The path of the SearchForStudies DICOMweb request (e.g., `studies`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2922,6 +4043,57 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.setIamPolicy * @memberOf! () * @@ -2994,12 +4166,67 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.storeInstances - * @desc StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1. + * @desc StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the StoreInstances DICOMweb request (e.g., + * // `studies/[{study_id}]`). Note that the `study_uid` is optional. + * dicomWebPath: 'studies', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.storeInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.storeInstances * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). + * @param {string} params.dicomWebPath The path of the StoreInstances DICOMweb request (e.g., `studies/[{study_id}]`). Note that the `study_uid` is optional. * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {().HttpBody} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3068,6 +4295,57 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.testIamPermissions * @memberOf! () * @@ -3217,6 +4495,10 @@ export namespace healthcare_v1beta1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ @@ -3292,7 +4574,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). + * The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). */ dicomWebPath?: string; /** @@ -3308,7 +4590,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `series`). + * The path of the SearchForSeries DICOMweb request(e.g., `series` or `studies/{study_uid}/series`). */ dicomWebPath?: string; /** @@ -3324,7 +4606,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies`). + * The path of the SearchForStudies DICOMweb request (e.g., `studies`). */ dicomWebPath?: string; /** @@ -3357,7 +4639,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). + * The path of the StoreInstances DICOMweb request (e.g., `studies/[{study_id}]`). Note that the `study_uid` is optional. */ dicomWebPath?: string; /** @@ -3401,11 +4683,58 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.delete * @desc DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the WADO-RS standard. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the DeleteStudy request (e.g., `studies/{study_id}`). + * dicomWebPath: 'studies/my-study', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.studies.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.studies.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). + * @param {string} params.dicomWebPath The path of the DeleteStudy request (e.g., `studies/{study_id}`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3472,12 +4801,63 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.retrieveMetadata - * @desc RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. + * @desc RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the RetrieveStudyMetadata DICOMweb request (e.g., + * // `studies/{study_id}/metadata`). + * dicomWebPath: 'studies/my-study/metadata', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.studies.retrieveMetadata(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.studies.retrieveMetadata * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/metadata`. + * @param {string} params.dicomWebPath The path of the RetrieveStudyMetadata DICOMweb request (e.g., `studies/{study_id}/metadata`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3544,12 +4924,63 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy - * @desc RetrieveStudy returns all instances within the given study. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.1. + * @desc RetrieveStudy returns all instances within the given study. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the RetrieveStudy DICOMweb request (e.g., + * // `studies/{study_id}`). + * dicomWebPath: 'studies/my-study', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). + * @param {string} params.dicomWebPath The path of the RetrieveStudy DICOMweb request (e.g., `studies/{study_id}`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3616,12 +5047,64 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.searchForInstances - * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the SearchForInstancesRequest DICOMweb request (e.g., + * // `instances` or `series/{series_uid}/instances` or + * // `studies/{study_uid}/instances`). + * dicomWebPath: 'studies/my-study/instances', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.studies.searchForInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.studies.searchForInstances * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). + * @param {string} params.dicomWebPath The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3688,12 +5171,63 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.searchForSeries - * @desc SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @desc SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the SearchForSeries DICOMweb request(e.g., `series` or + * // `studies/{study_uid}/series`). + * dicomWebPath: 'studies/my-study/series', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.studies.searchForSeries(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.studies.searchForSeries * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `series`). + * @param {string} params.dicomWebPath The path of the SearchForSeries DICOMweb request(e.g., `series` or `studies/{study_uid}/series`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3760,12 +5294,67 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.storeInstances - * @desc StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1. + * @desc StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the StoreInstances DICOMweb request (e.g., + * // `studies/[{study_id}]`). Note that the `study_uid` is optional. + * dicomWebPath: 'studies/my-study', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.studies.storeInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.studies.storeInstances * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). + * @param {string} params.dicomWebPath The path of the StoreInstances DICOMweb request (e.g., `studies/[{study_id}]`). Note that the `study_uid` is optional. * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {().HttpBody} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3840,7 +5429,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). + * The path of the DeleteStudy request (e.g., `studies/{study_id}`). */ dicomWebPath?: string; /** @@ -3856,7 +5445,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/metadata`. + * The path of the RetrieveStudyMetadata DICOMweb request (e.g., `studies/{study_id}/metadata`). */ dicomWebPath?: string; /** @@ -3872,7 +5461,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). + * The path of the RetrieveStudy DICOMweb request (e.g., `studies/{study_id}`). */ dicomWebPath?: string; /** @@ -3888,7 +5477,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). + * The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). */ dicomWebPath?: string; /** @@ -3904,7 +5493,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `series`). + * The path of the SearchForSeries DICOMweb request(e.g., `series` or `studies/{study_uid}/series`). */ dicomWebPath?: string; /** @@ -3920,7 +5509,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}`). + * The path of the StoreInstances DICOMweb request (e.g., `studies/[{study_id}]`). Note that the `study_uid` is optional. */ dicomWebPath?: string; /** @@ -3947,11 +5536,59 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.delete * @desc DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the WADO-RS standard. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the DeleteSeries request (e.g., + * // `studies/{study_id}/series/{series_id}`). + * dicomWebPath: 'studies/my-study/series/my-sery', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.studies.series.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}`). + * @param {string} params.dicomWebPath The path of the DeleteSeries request (e.g., `studies/{study_id}/series/{series_id}`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4018,12 +5655,63 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveMetadata - * @desc RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. + * @desc RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the RetrieveSeriesMetadata DICOMweb request (e.g., + * // `studies/{study_id}/series/{series_id}/metadata`). + * dicomWebPath: 'studies/my-study/series/my-sery/metadata', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.studies.series.retrieveMetadata(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveMetadata * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/metadata`. + * @param {string} params.dicomWebPath The path of the RetrieveSeriesMetadata DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/metadata`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4090,12 +5778,63 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveSeries - * @desc RetrieveSeries returns all instances within the given study and series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.2. + * @desc RetrieveSeries returns all instances within the given study and series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the RetrieveSeries DICOMweb request (e.g., + * // `studies/{study_id}/series/{series_id}`). + * dicomWebPath: 'studies/my-study/series/my-sery', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.studies.series.retrieveSeries(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveSeries * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}`). + * @param {string} params.dicomWebPath The path of the RetrieveSeries DICOMweb request (e.g., `studies/{study_id}/series/{series_id}`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4162,12 +5901,64 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.searchForInstances - * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + * @desc SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the SearchForInstancesRequest DICOMweb request (e.g., + * // `instances` or `series/{series_uid}/instances` or + * // `studies/{study_uid}/instances`). + * dicomWebPath: 'studies/my-study/series/my-sery/instances', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.studies.series.searchForInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.searchForInstances * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). + * @param {string} params.dicomWebPath The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4241,7 +6032,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}`). + * The path of the DeleteSeries request (e.g., `studies/{study_id}/series/{series_id}`). */ dicomWebPath?: string; /** @@ -4257,7 +6048,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/metadata`. + * The path of the RetrieveSeriesMetadata DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/metadata`). */ dicomWebPath?: string; /** @@ -4273,7 +6064,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}`). + * The path of the RetrieveSeries DICOMweb request (e.g., `studies/{study_id}/series/{series_id}`). */ dicomWebPath?: string; /** @@ -4289,7 +6080,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `instances`). + * The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). */ dicomWebPath?: string; /** @@ -4311,11 +6102,59 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete * @desc DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the WADO-RS standard. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the DeleteInstance request (e.g., + * // `studies/{study_id}/series/{series_id}/instances/{instance_id}`). + * dicomWebPath: 'studies/my-study/series/my-sery/instances/my-instance', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). + * @param {string} params.dicomWebPath The path of the DeleteInstance request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4382,14 +6221,65 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance - * @desc RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.3. - * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance - * @memberOf! () + * @desc RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the RetrieveInstance DICOMweb request (e.g., + * // `studies/{study_id}/series/{series_id}/instances/{instance_id}`). + * dicomWebPath: 'studies/my-study/series/my-sery/instances/my-instance', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } + * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.dicomWebPath The path of the RetrieveInstance DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). + * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_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 */ @@ -4454,12 +6344,63 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata - * @desc RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. + * @desc RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the RetrieveInstanceMetadata DICOMweb request (e.g., + * // `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). + * dicomWebPath: 'studies/my-study/series/my-sery/instances/my-instance/metadata', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). + * @param {string} params.dicomWebPath The path of the RetrieveInstanceMetadata DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4526,12 +6467,63 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveRendered - * @desc RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8. + * @desc RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the RetrieveRenderedInstance DICOMweb request (e.g., + * // `studies/{study_id}/series/{series_id}/instances/{instance_id}/rendered`). + * dicomWebPath: 'studies/my-study/series/my-sery/instances/my-instance/rendered', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveRendered(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveRendered * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/rendered`). + * @param {string} params.dicomWebPath The path of the RetrieveRenderedInstance DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/rendered`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4605,7 +6597,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). + * The path of the DeleteInstance request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). */ dicomWebPath?: string; /** @@ -4621,7 +6613,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}`). + * The path of the RetrieveInstance DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). */ dicomWebPath?: string; /** @@ -4637,7 +6629,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). + * The path of the RetrieveInstanceMetadata DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). */ dicomWebPath?: string; /** @@ -4653,7 +6645,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/rendered`). + * The path of the RetrieveRenderedInstance DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/rendered`). */ dicomWebPath?: string; /** @@ -4670,12 +6662,63 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames - * @desc RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.4. + * @desc RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the RetrieveFrames DICOMweb request (e.g., + * // `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}`). + * dicomWebPath: 'studies/my-study/series/my-sery/instances/my-instance/frames/my-frame', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}`). + * @param {string} params.dicomWebPath The path of the RetrieveFrames DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4742,12 +6785,63 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered - * @desc RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8. + * @desc RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the DICOM store that is being accessed (e.g., + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/dicomStores/my-dicom-store', // TODO: Update placeholder value. + * + * // The path of the RetrieveRenderedFrames DICOMweb request (e.g., + * // `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}/rendered`). + * dicomWebPath: 'studies/my-study/series/my-sery/instances/my-instance/frames/my-frame/rendered', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}/rendered`). + * @param {string} params.dicomWebPath The path of the RetrieveRenderedFrames DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}/rendered`). * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4821,7 +6915,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}`). + * The path of the RetrieveFrames DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}`). */ dicomWebPath?: string; /** @@ -4837,7 +6931,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., `studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}/rendered`). + * The path of the RetrieveRenderedFrames DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}/rendered`). */ dicomWebPath?: string; /** @@ -4859,6 +6953,56 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.create * @desc Creates a new FHIR store within the parent dataset. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the dataset this FHIR store belongs to. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.create * @memberOf! () * @@ -4935,6 +7079,49 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.delete * @desc Deletes the specified FHIR store and removes all resources within it. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the FHIR store to delete. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhir-store', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.delete * @memberOf! () * @@ -5004,6 +7191,58 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.export * @desc Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the FHIR store to export resource from. The name should be in + * // the format of + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhir-store', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.export(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.export * @memberOf! () * @@ -5079,6 +7318,52 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.get * @desc Gets the configuration of the specified FHIR store. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the FHIR store to get. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhir-store', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.get * @memberOf! () * @@ -5150,10 +7435,58 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhir-store', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5222,6 +7555,58 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.import * @desc Import resources to the FHIR store by loading data from the specified sources. Each resource must have a client-supplied ID, which is retained by the server. The import operation is idempotent. Upon retry, the most recent data (matching the client-supplied ID) is overwritten, without creating a new resource version. If partial failures occur during the import, successful changes are not rolled back. If history imports are enabled (enable_history_import is set in the FHIR store's configuration), you can import historical versions of a resource by supplying a bundle of type `history`. The historical versions in the bundle must have `lastUpdated` timestamps. If a current or historical version with the supplied resource ID already exists, the bundle is rejected. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the FHIR store to import FHIR resources to. The name should be + * // in the format of + * // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhir-store', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.import(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.import * @memberOf! () * @@ -5297,6 +7682,65 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.list * @desc Lists the FHIR stores in the given dataset. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of the dataset. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var fhirStoresPage = response['fhirStores']; + * if (!fhirStoresPage) { + * return; + * } + * for (var i = 0; i < fhirStoresPage.length; i++) { + * // TODO: Change code below to process each resource in `fhirStoresPage`: + * console.log(JSON.stringify(fhirStoresPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudHealthcare.projects.locations.datasets.fhirStores.list(request, handlePage); + * } + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.list * @memberOf! () * @@ -5376,6 +7820,58 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.patch * @desc Updates the configuration of the specified FHIR store. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Output only. Resource name of the FHIR store, of the form + * // `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhir-store', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.patch * @memberOf! () * @@ -5449,6 +7945,57 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhir-store', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.setIamPolicy * @memberOf! () * @@ -5522,6 +8069,57 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhir-store', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.testIamPermissions * @memberOf! () * @@ -5671,6 +8269,10 @@ export namespace healthcare_v1beta1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ @@ -5782,6 +8384,52 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.capabilities * @desc Gets the FHIR [capability statement](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html) for the store, which contains a description of functionality supported by the server. Implements the FHIR standard [capabilities interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities). On success, the response body will contain a JSON-encoded representation of a `CapabilityStatement` resource. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of the FHIR store to retrieve the capabilities for. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhir-store', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.fhir.capabilities(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.fhir.capabilities * @memberOf! () * @@ -5854,6 +8502,54 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete * @desc Deletes FHIR resources that match a search query. Implements the FHIR standard [conditional delete interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1). If multiple resources match, all of them will be deleted. Search terms are provided as query parameters following the same pattern as the search method. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the FHIR store this resource belongs to. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhir-store', // TODO: Update placeholder value. + * + * // The FHIR resource type to delete, such as Patient or Observation. For a + * // complete list, see the [FHIR Resource + * // Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + * type: 'my-type', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete * @memberOf! () * @@ -5927,6 +8623,62 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch * @desc If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard [conditional patch interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#patch). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request will return a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the FHIR store this resource belongs to. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhir-store', // TODO: Update placeholder value. + * + * // The FHIR resource type to update, such as Patient or Observation. For a + * // complete list, see the [FHIR Resource + * // Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + * type: 'my-type', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch * @memberOf! () * @@ -6001,6 +8753,63 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate * @desc If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard [conditional update interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#cond-update). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request will return a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource will be created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the FHIR store this resource belongs to. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhir-store', // TODO: Update placeholder value. + * + * // The FHIR resource type to update, such as Patient or Observation. For a + * // complete list, see the [FHIR Resource + * // Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + * // Must match the resource type in the provided content. + * type: 'my-type', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate * @memberOf! () * @@ -6075,6 +8884,62 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.create * @desc Creates a FHIR resource. Implements the FHIR standard [create interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#create), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard [conditional create interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body will contain a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the FHIR store this resource belongs to. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhir-store', // TODO: Update placeholder value. + * + * // The FHIR resource type to create, such as Patient or Observation. For a + * // complete list, see the [FHIR Resource + * // Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + * // Must match the resource type in the provided content. + * type: 'my-type', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.fhir.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.fhir.create * @memberOf! () * @@ -6149,6 +9014,52 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.delete * @desc Deletes a FHIR resource. Implements the FHIR standard [delete interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#delete). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the resource to delete. + * name: 'my-name', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.fhir.delete(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.fhir.delete * @memberOf! () * @@ -6218,6 +9129,56 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle * @desc Executes all the requests in the given Bundle. Implements the FHIR standard [batch/transaction interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the [batch processing rules](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1) and [transaction processing rules](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction the response body will contain a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of the FHIR store in which this bundle will be executed. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhir-store', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.fhir.executeBundle(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle * @memberOf! () * @@ -6291,6 +9252,52 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.history * @desc Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard [history interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#history). On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the resource to retrieve. + * name: 'my-name', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.fhir.history(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.fhir.history * @memberOf! () * @@ -6367,6 +9374,52 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.Observation-lastn * @desc Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation [Observation-lastn](http://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn). Search terms are provided as query parameters following the same pattern as the search method. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of the FHIR store to retrieve resources from. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhir-store', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.fhir.observationLastn(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.fhir.Observation-lastn * @memberOf! () * @@ -6438,6 +9491,57 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.patch * @desc Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard [patch interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#patch). The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the resource to update. + * name: 'my-name', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.fhir.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.fhir.patch * @memberOf! () * @@ -6508,6 +9612,52 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything * @desc Retrieves all the resources in the patient compartment for a `Patient` resource. Implements the FHIR extended operation [Patient-everything](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything). On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of the `Patient` resource for which the information is required. + * name: 'my-name', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.fhir.patientEverything(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything * @memberOf! () * @@ -6582,6 +9732,52 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.read * @desc Gets the contents of a FHIR resource. Implements the FHIR standard [read interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#read). Also supports the FHIR standard [conditional read interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#cread) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the resource to retrieve. + * name: 'my-name', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.fhir.read(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.fhir.read * @memberOf! () * @@ -6651,6 +9847,49 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.Resource-purge * @desc Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method. This is not a FHIR standard operation. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the resource to purge. + * name: 'my-name', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.fhir.resourcePurge(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.fhir.Resource-purge * @memberOf! () * @@ -6722,7 +9961,57 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.search - * @desc Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard [search interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#search) using the search semantics described in the [FHIR Search specification](http://hl7.org/implement/standards/fhir/STU3/search.html). Supports three methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method. The `GET` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. # Search Parameters The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the [FHIR Search Parameter Registry](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html). # Search Modifiers Modifier | Supported ----------- | --------- `:missing` | Yes `:exact` | Yes `:contains` | Yes `:text` | Yes `:in` | Yes `:not-in` | Yes `:above` | Yes `:below` | Yes `:[type]` | Yes `:not` | Yes `:recurse` | No + * @desc Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard [search interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#search) using the search semantics described in the [FHIR Search specification](http://hl7.org/implement/standards/fhir/STU3/search.html). Supports three methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method. The `GET` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the [FHIR Search Parameter Registry](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html). Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` will contain pagination links. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of the FHIR store to retrieve resources from. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset/fhirStores/my-fhir-store', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.fhir.search(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.fhir.search * @memberOf! () * @@ -6796,6 +10085,57 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.update * @desc Updates the entire contents of a resource. Implements the FHIR standard [update interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#update). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the resource to update. + * name: 'my-name', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.fhir.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.fhir.update * @memberOf! () * @@ -6866,6 +10206,52 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.vread * @desc Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard [vread interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#vread). On success, the response body will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the resource version to retrieve. + * name: 'my-name', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.fhirStores.fhir.vread(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.fhirStores.fhir.vread * @memberOf! () * @@ -7214,6 +10600,56 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.create * @desc Creates a new HL7v2 store within the parent dataset. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the dataset this HL7v2 store belongs to. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.hl7V2Stores.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.hl7V2Stores.create * @memberOf! () * @@ -7290,6 +10726,49 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.delete * @desc Deletes the specified HL7v2 store and removes all messages that are contained within it. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the HL7v2 store to delete. + * name: 'my-name', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.hl7V2Stores.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.hl7V2Stores.delete * @memberOf! () * @@ -7359,6 +10838,52 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.get * @desc Gets the specified HL7v2 store. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the HL7v2 store to get. + * name: 'my-name', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.hl7V2Stores.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.hl7V2Stores.get * @memberOf! () * @@ -7430,10 +10955,58 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'my-resource', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7502,6 +11075,65 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.list * @desc Lists the HL7v2 stores in the given dataset. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of the dataset. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var hl7V2StoresPage = response['hl7V2Stores']; + * if (!hl7V2StoresPage) { + * return; + * } + * for (var i = 0; i < hl7V2StoresPage.length; i++) { + * // TODO: Change code below to process each resource in `hl7V2StoresPage`: + * console.log(JSON.stringify(hl7V2StoresPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudHealthcare.projects.locations.datasets.hl7V2Stores.list(request, handlePage); + * } + * }; + * + * cloudHealthcare.projects.locations.datasets.hl7V2Stores.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.hl7V2Stores.list * @memberOf! () * @@ -7581,6 +11213,58 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.patch * @desc Updates the HL7v2 store. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Output only. Resource name of the HL7v2 store, of the form + * // `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + * name: 'my-name', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.hl7V2Stores.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.hl7V2Stores.patch * @memberOf! () * @@ -7654,6 +11338,57 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'my-resource', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy * @memberOf! () * @@ -7727,6 +11462,57 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'my-resource', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions * @memberOf! () * @@ -7859,6 +11645,10 @@ export namespace healthcare_v1beta1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ @@ -7953,6 +11743,56 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.messages.create * @desc Creates a message and sends a notification to the Cloud Pub/Sub topic. If configured, the MLLP adapter listens to messages created by this method and sends those back to the hospital. A successful response indicates the message has been persisted to storage and a Cloud Pub/Sub notification has been sent. Sending to the hospital by the MLLP adapter happens asynchronously. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the dataset this message belongs to. + * parent: 'my-parent', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.hl7V2Stores.messages.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.create * @memberOf! () * @@ -8026,6 +11866,49 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.messages.delete * @desc Deletes an HL7v2 message. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the HL7v2 message to delete. + * name: 'my-name', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.hl7V2Stores.messages.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.delete * @memberOf! () * @@ -8095,6 +11978,52 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.messages.get * @desc Gets an HL7v2 message. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the HL7v2 message to retrieve. + * name: 'my-name', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.hl7V2Stores.messages.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.get * @memberOf! () * @@ -8165,6 +12094,56 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest * @desc Ingests a new HL7v2 message from the hospital and sends a notification to the Cloud Pub/Sub topic. Return is an HL7v2 ACK message if the message was successfully stored. Otherwise an error is returned. If an identical HL7v2 message is created twice only one resource is created on the server and no error is reported. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the HL7v2 store this message belongs to. + * parent: 'my-parent', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.hl7V2Stores.messages.ingest(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest * @memberOf! () * @@ -8242,6 +12221,65 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.messages.list * @desc Lists all the messages in the given HL7v2 store with support for filtering. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of the HL7v2 store to retrieve messages from. + * parent: 'my-parent', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var messagesPage = response['messages']; + * if (!messagesPage) { + * return; + * } + * for (var i = 0; i < messagesPage.length; i++) { + * // TODO: Change code below to process each resource in `messagesPage`: + * console.log(JSON.stringify(messagesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudHealthcare.projects.locations.datasets.hl7V2Stores.messages.list(request, handlePage); + * } + * }; + * + * cloudHealthcare.projects.locations.datasets.hl7V2Stores.messages.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.list * @memberOf! () * @@ -8322,6 +12360,59 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.messages.patch * @desc Update the message. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // Resource name of the Message, of the form + * // `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. + * // Assigned by the server. + * name: 'my-name', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.hl7V2Stores.messages.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.patch * @memberOf! () * @@ -8512,6 +12603,52 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.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. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * cloudHealthcare.projects.locations.datasets.operations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.operations.get * @memberOf! () * @@ -8583,6 +12720,65 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.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. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Healthcare API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/healthcare + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var cloudHealthcare = google.cloudhealthcare('v1beta1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var operationsPage = response['operations']; + * if (!operationsPage) { + * return; + * } + * for (var i = 0; i < operationsPage.length; i++) { + * // TODO: Change code below to process each resource in `operationsPage`: + * console.log(JSON.stringify(operationsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * cloudHealthcare.projects.locations.datasets.operations.list(request, handlePage); + * } + * }; + * + * cloudHealthcare.projects.locations.datasets.operations.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias healthcare.projects.locations.datasets.operations.list * @memberOf! () * diff --git a/src/apis/healthcare/webpack.config.js b/src/apis/healthcare/webpack.config.js index 7e4545108af..8301675d2e3 100644 --- a/src/apis/healthcare/webpack.config.js +++ b/src/apis/healthcare/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/iam/package.json b/src/apis/iam/package.json index 905909debfe..9e678491955 100644 --- a/src/apis/iam/package.json +++ b/src/apis/iam/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/iam/v1.ts b/src/apis/iam/v1.ts index d0271f2a13b..373d1494135 100644 --- a/src/apis/iam/v1.ts +++ b/src/apis/iam/v1.ts @@ -225,7 +225,7 @@ export namespace iam_v1 { */ role?: Schema$Role; /** - * The role id to use for this role. + * The role ID to use for this role. */ roleId?: string; } @@ -634,6 +634,10 @@ export namespace iam_v1 { * Specifies the algorithm (and possibly key size) for the key. */ keyAlgorithm?: string; + /** + * The key origin. + */ + keyOrigin?: string; /** * The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. */ @@ -763,6 +767,53 @@ export namespace iam_v1 { /** * iam.iamPolicies.lintPolicy * @desc Lints a Cloud IAM policy object or its sub fields. Currently supports google.iam.v1.Policy, google.iam.v1.Binding and google.iam.v1.Binding.condition. Each lint operation consists of multiple lint validation units. Validation units have the following properties: - Each unit inspects the input object in regard to a particular linting aspect and issues a google.iam.admin.v1.LintResult disclosing the result. - Domain of discourse of each unit can be either google.iam.v1.Policy, google.iam.v1.Binding, or google.iam.v1.Binding.condition depending on the purpose of the validation. - A unit may require additional data (like the list of all possible enumerable values of a particular attribute used in the policy instance) which shall be provided by the caller. Refer to the comments of google.iam.admin.v1.LintPolicyRequest.context for more details. The set of applicable validation units is determined by the Cloud IAM server and is not configurable. Regardless of any lint issues or their severities, successful calls to `lintPolicy` return an HTTP 200 OK status code. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * iam.iamPolicies.lintPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.iamPolicies.lintPolicy * @memberOf! () * @@ -837,6 +888,53 @@ export namespace iam_v1 { /** * iam.iamPolicies.queryAuditableServices * @desc Returns a list of services that support service level audit logging configuration for the given resource. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * iam.iamPolicies.queryAuditableServices(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.iamPolicies.queryAuditableServices * @memberOf! () * @@ -961,11 +1059,63 @@ export namespace iam_v1 { /** * iam.organizations.roles.create * @desc Creates a new Role. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the parent resource in one of the following formats: + * // `organizations/{ORGANIZATION_ID}` + * // `projects/{PROJECT_ID}` + * parent: 'organizations/my-organization', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * iam.organizations.roles.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.organizations.roles.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The resource name of the parent resource in one of the following formats: `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` + * @param {string} params.parent The `parent` parameter's value depends on the target resource for the request, namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`projects.roles.create()`](/iam/reference/rest/v1/projects.roles/create): `projects/{PROJECT_ID}`. This method creates project-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.create()`](/iam/reference/rest/v1/organizations.roles/create): `organizations/{ORGANIZATION_ID}`. This method creates organization-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. * @param {().CreateRoleRequest} 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. @@ -1034,12 +1184,60 @@ export namespace iam_v1 { /** * iam.organizations.roles.delete * @desc Soft deletes a role. The role is suspended and cannot be used to create new IAM Policy Bindings. The Role will not be included in `ListRoles()` unless `show_deleted` is set in the `ListRolesRequest`. The Role contains the deleted boolean set. Existing Bindings remains, but are inactive. The Role can be undeleted within 7 days. After 7 days the Role is deleted and all Bindings associated with the role are removed. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the role in one of the following formats: + * // `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` + * // `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * name: 'organizations/my-organization/roles/my-role', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * iam.organizations.roles.delete(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.organizations.roles.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.etag Used to perform a consistent read-modify-write. - * @param {string} params.name The resource name of the role in one of the following formats: `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * @param {string} params.name The `name` parameter's value depends on the target resource for the request, namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.delete()`](/iam/reference/rest/v1/projects.roles/delete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.delete()`](/iam/reference/rest/v1/organizations.roles/delete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization 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 @@ -1104,11 +1302,60 @@ export namespace iam_v1 { /** * iam.organizations.roles.get * @desc Gets a Role definition. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the role in one of the following formats: + * // `roles/{ROLE_NAME}` + * // `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` + * // `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * name: 'organizations/my-organization/roles/my-role', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * iam.organizations.roles.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.organizations.roles.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * @param {string} params.name The `name` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization 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 @@ -1173,13 +1420,75 @@ export namespace iam_v1 { /** * iam.organizations.roles.list * @desc Lists the Roles defined on a resource. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the parent resource in one of the following formats: + * // `` (empty string) -- this refers to curated roles. + * // `organizations/{ORGANIZATION_ID}` + * // `projects/{PROJECT_ID}` + * parent: 'organizations/my-organization', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var rolesPage = response['roles']; + * if (!rolesPage) { + * return; + * } + * for (var i = 0; i < rolesPage.length; i++) { + * // TODO: Change code below to process each resource in `rolesPage`: + * console.log(JSON.stringify(rolesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * iam.organizations.roles.list(request, handlePage); + * } + * }; + * + * iam.organizations.roles.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.organizations.roles.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize Optional limit on the number of roles to include in the response. * @param {string=} params.pageToken Optional pagination token returned in an earlier ListRolesResponse. - * @param {string} params.parent The resource name of the parent resource in one of the following formats: `` (empty string) -- this refers to curated roles. `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` + * @param {string} params.parent The `parent` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. * @param {boolean=} params.showDeleted Include Roles that have been deleted. * @param {string=} params.view Optional view for the returned Role objects. When `FULL` is specified, the `includedPermissions` field is returned, which includes a list of all permissions in the role. The default value is `BASIC`, which does not return the `includedPermissions` field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1251,11 +1560,65 @@ export namespace iam_v1 { /** * iam.organizations.roles.patch * @desc Updates a Role definition. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the role in one of the following formats: + * // `roles/{ROLE_NAME}` + * // `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` + * // `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * name: 'organizations/my-organization/roles/my-role', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * iam.organizations.roles.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.organizations.roles.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * @param {string} params.name The `name` parameter's value depends on the target resource for the request, namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.patch()`](/iam/reference/rest/v1/projects.roles/patch): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.patch()`](/iam/reference/rest/v1/organizations.roles/patch): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. * @param {string=} params.updateMask A mask describing which fields in the Role have changed. * @param {().Role} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1322,11 +1685,63 @@ export namespace iam_v1 { /** * iam.organizations.roles.undelete * @desc Undelete a Role, bringing it back in its previous state. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the role in one of the following formats: + * // `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` + * // `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * name: 'organizations/my-organization/roles/my-role', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * iam.organizations.roles.undelete(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.organizations.roles.undelete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the role in one of the following formats: `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * @param {string} params.name The `name` parameter's value depends on the target resource for the request, namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.undelete()`](/iam/reference/rest/v1/projects.roles/undelete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.undelete()`](/iam/reference/rest/v1/organizations.roles/undelete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. * @param {().UndeleteRoleRequest} 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. @@ -1401,7 +1816,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the parent resource in one of the following formats: `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` + * The `parent` parameter's value depends on the target resource for the request, namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`projects.roles.create()`](/iam/reference/rest/v1/projects.roles/create): `projects/{PROJECT_ID}`. This method creates project-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.create()`](/iam/reference/rest/v1/organizations.roles/create): `organizations/{ORGANIZATION_ID}`. This method creates organization-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */ parent?: string; @@ -1422,7 +1837,7 @@ export namespace iam_v1 { */ etag?: string; /** - * The resource name of the role in one of the following formats: `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The `name` parameter's value depends on the target resource for the request, namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.delete()`](/iam/reference/rest/v1/projects.roles/delete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.delete()`](/iam/reference/rest/v1/organizations.roles/delete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */ name?: string; } @@ -1434,7 +1849,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The `name` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */ name?: string; } @@ -1454,7 +1869,7 @@ export namespace iam_v1 { */ pageToken?: string; /** - * The resource name of the parent resource in one of the following formats: `` (empty string) -- this refers to curated roles. `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` + * The `parent` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */ parent?: string; /** @@ -1474,7 +1889,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The `name` parameter's value depends on the target resource for the request, namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.patch()`](/iam/reference/rest/v1/projects.roles/patch): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.patch()`](/iam/reference/rest/v1/organizations.roles/patch): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */ name?: string; /** @@ -1495,7 +1910,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the role in one of the following formats: `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The `name` parameter's value depends on the target resource for the request, namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.undelete()`](/iam/reference/rest/v1/projects.roles/undelete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.undelete()`](/iam/reference/rest/v1/organizations.roles/undelete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */ name?: string; @@ -1514,6 +1929,66 @@ export namespace iam_v1 { /** * iam.permissions.queryTestablePermissions * @desc Lists the permissions testable on a resource. A permission is testable if it can be tested for an identity on a resource. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var permissionsPage = response['permissions']; + * if (!permissionsPage) { + * return; + * } + * for (var i = 0; i < permissionsPage.length; i++) { + * // TODO: Change code below to process each resource in `permissionsPage`: + * console.log(JSON.stringify(permissionsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.resource.pageToken = response.nextPageToken; + * iam.permissions.queryTestablePermissions(request, handlePage); + * } + * }; + * + * iam.permissions.queryTestablePermissions(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.permissions.queryTestablePermissions * @memberOf! () * @@ -1630,11 +2105,63 @@ export namespace iam_v1 { /** * iam.projects.roles.create * @desc Creates a new Role. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the parent resource in one of the following formats: + * // `organizations/{ORGANIZATION_ID}` + * // `projects/{PROJECT_ID}` + * parent: 'projects/my-project', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * iam.projects.roles.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.roles.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The resource name of the parent resource in one of the following formats: `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` + * @param {string} params.parent The `parent` parameter's value depends on the target resource for the request, namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`projects.roles.create()`](/iam/reference/rest/v1/projects.roles/create): `projects/{PROJECT_ID}`. This method creates project-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.create()`](/iam/reference/rest/v1/organizations.roles/create): `organizations/{ORGANIZATION_ID}`. This method creates organization-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. * @param {().CreateRoleRequest} 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. @@ -1703,12 +2230,60 @@ export namespace iam_v1 { /** * iam.projects.roles.delete * @desc Soft deletes a role. The role is suspended and cannot be used to create new IAM Policy Bindings. The Role will not be included in `ListRoles()` unless `show_deleted` is set in the `ListRolesRequest`. The Role contains the deleted boolean set. Existing Bindings remains, but are inactive. The Role can be undeleted within 7 days. After 7 days the Role is deleted and all Bindings associated with the role are removed. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the role in one of the following formats: + * // `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` + * // `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * name: 'projects/my-project/roles/my-role', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * iam.projects.roles.delete(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.roles.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.etag Used to perform a consistent read-modify-write. - * @param {string} params.name The resource name of the role in one of the following formats: `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * @param {string} params.name The `name` parameter's value depends on the target resource for the request, namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.delete()`](/iam/reference/rest/v1/projects.roles/delete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.delete()`](/iam/reference/rest/v1/organizations.roles/delete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization 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 @@ -1773,11 +2348,60 @@ export namespace iam_v1 { /** * iam.projects.roles.get * @desc Gets a Role definition. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the role in one of the following formats: + * // `roles/{ROLE_NAME}` + * // `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` + * // `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * name: 'projects/my-project/roles/my-role', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * iam.projects.roles.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.roles.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * @param {string} params.name The `name` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization 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 @@ -1842,13 +2466,75 @@ export namespace iam_v1 { /** * iam.projects.roles.list * @desc Lists the Roles defined on a resource. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the parent resource in one of the following formats: + * // `` (empty string) -- this refers to curated roles. + * // `organizations/{ORGANIZATION_ID}` + * // `projects/{PROJECT_ID}` + * parent: 'projects/my-project', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var rolesPage = response['roles']; + * if (!rolesPage) { + * return; + * } + * for (var i = 0; i < rolesPage.length; i++) { + * // TODO: Change code below to process each resource in `rolesPage`: + * console.log(JSON.stringify(rolesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * iam.projects.roles.list(request, handlePage); + * } + * }; + * + * iam.projects.roles.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.roles.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize Optional limit on the number of roles to include in the response. * @param {string=} params.pageToken Optional pagination token returned in an earlier ListRolesResponse. - * @param {string} params.parent The resource name of the parent resource in one of the following formats: `` (empty string) -- this refers to curated roles. `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` + * @param {string} params.parent The `parent` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. * @param {boolean=} params.showDeleted Include Roles that have been deleted. * @param {string=} params.view Optional view for the returned Role objects. When `FULL` is specified, the `includedPermissions` field is returned, which includes a list of all permissions in the role. The default value is `BASIC`, which does not return the `includedPermissions` field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1920,11 +2606,65 @@ export namespace iam_v1 { /** * iam.projects.roles.patch * @desc Updates a Role definition. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the role in one of the following formats: + * // `roles/{ROLE_NAME}` + * // `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` + * // `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * name: 'projects/my-project/roles/my-role', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * iam.projects.roles.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.roles.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * @param {string} params.name The `name` parameter's value depends on the target resource for the request, namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.patch()`](/iam/reference/rest/v1/projects.roles/patch): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.patch()`](/iam/reference/rest/v1/organizations.roles/patch): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. * @param {string=} params.updateMask A mask describing which fields in the Role have changed. * @param {().Role} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1991,11 +2731,63 @@ export namespace iam_v1 { /** * iam.projects.roles.undelete * @desc Undelete a Role, bringing it back in its previous state. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the role in one of the following formats: + * // `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` + * // `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * name: 'projects/my-project/roles/my-role', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * iam.projects.roles.undelete(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.roles.undelete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the role in one of the following formats: `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * @param {string} params.name The `name` parameter's value depends on the target resource for the request, namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.undelete()`](/iam/reference/rest/v1/projects.roles/undelete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.undelete()`](/iam/reference/rest/v1/organizations.roles/undelete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. * @param {().UndeleteRoleRequest} 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. @@ -2070,7 +2862,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the parent resource in one of the following formats: `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` + * The `parent` parameter's value depends on the target resource for the request, namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`projects.roles.create()`](/iam/reference/rest/v1/projects.roles/create): `projects/{PROJECT_ID}`. This method creates project-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.create()`](/iam/reference/rest/v1/organizations.roles/create): `organizations/{ORGANIZATION_ID}`. This method creates organization-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */ parent?: string; @@ -2091,7 +2883,7 @@ export namespace iam_v1 { */ etag?: string; /** - * The resource name of the role in one of the following formats: `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The `name` parameter's value depends on the target resource for the request, namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.delete()`](/iam/reference/rest/v1/projects.roles/delete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.delete()`](/iam/reference/rest/v1/organizations.roles/delete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */ name?: string; } @@ -2103,7 +2895,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The `name` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */ name?: string; } @@ -2123,7 +2915,7 @@ export namespace iam_v1 { */ pageToken?: string; /** - * The resource name of the parent resource in one of the following formats: `` (empty string) -- this refers to curated roles. `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` + * The `parent` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */ parent?: string; /** @@ -2143,7 +2935,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The `name` parameter's value depends on the target resource for the request, namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.patch()`](/iam/reference/rest/v1/projects.roles/patch): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.patch()`](/iam/reference/rest/v1/organizations.roles/patch): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */ name?: string; /** @@ -2164,7 +2956,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the role in one of the following formats: `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The `name` parameter's value depends on the target resource for the request, namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`projects.roles.undelete()`](/iam/reference/rest/v1/projects.roles/undelete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.undelete()`](/iam/reference/rest/v1/organizations.roles/undelete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */ name?: string; @@ -2185,6 +2977,57 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.create * @desc Creates a ServiceAccount and returns it. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The resource name of the project associated with the service + * // accounts, such as `projects/my-project-123`. + * name: 'projects/my-project', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.create * @memberOf! () * @@ -2260,6 +3103,53 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.delete * @desc Deletes a ServiceAccount. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the service account in the following format: + * // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. + * // Using `-` as a wildcard for the `PROJECT_ID` will infer the project from + * // the account. The `ACCOUNT` value can be the `email` address or the + * // `unique_id` of the service account. + * name: 'projects/my-project/serviceAccounts/my-service-account', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.delete * @memberOf! () * @@ -2329,6 +3219,57 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.disable * @desc DisableServiceAccount is currently in the alpha launch stage. Disables a ServiceAccount, which immediately prevents the service account from authenticating and gaining access to APIs. Disabled service accounts can be safely restored by using EnableServiceAccount at any point. Deleted service accounts cannot be restored using this method. Disabling a service account that is bound to VMs, Apps, Functions, or other jobs will cause those jobs to lose access to resources if they are using the disabled service account. To improve reliability of your services and avoid unexpected outages, it is recommended to first disable a service account rather than delete it. After disabling the service account, wait at least 24 hours to verify there are no unintended consequences, and then delete the service account. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the service account in the following format: + * // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. + * // Using `-` as a wildcard for the `PROJECT_ID` will infer the project from + * // the account. The `ACCOUNT` value can be the `email` address or the + * // `unique_id` of the service account. + * name: 'projects/my-project/serviceAccounts/my-service-account', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.disable(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.disable * @memberOf! () * @@ -2402,6 +3343,56 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.enable * @desc EnableServiceAccount is currently in the alpha launch stage. Restores a disabled ServiceAccount that has been manually disabled by using DisableServiceAccount. Service accounts that have been disabled by other means or for other reasons, such as abuse, cannot be restored using this method. EnableServiceAccount will have no effect on a service account that is not disabled. Enabling an already enabled service account will have no effect. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the service account in the following format: + * // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_UNIQUE_ID}'. + * // Using `-` as a wildcard for the `PROJECT_ID` will infer the project from + * // the account. + * name: 'projects/my-project/serviceAccounts/my-service-account', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.enable(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.enable * @memberOf! () * @@ -2472,6 +3463,56 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.get * @desc Gets a ServiceAccount. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the service account in the following format: + * // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. + * // Using `-` as a wildcard for the `PROJECT_ID` will infer the project from + * // the account. The `ACCOUNT` value can be the `email` address or the + * // `unique_id` of the service account. + * name: 'projects/my-project/serviceAccounts/my-service-account', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.get * @memberOf! () * @@ -2543,10 +3584,58 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.getIamPolicy * @desc Returns the Cloud IAM access control policy for a ServiceAccount. Note: Service accounts are both [resources and identities](/iam/docs/service-accounts#service_account_permissions). This method treats the service account as a resource. It returns the Cloud IAM policy that reflects what members have access to the service account. This method does not return what resources the service account has access to. To see if a service account has access to a resource, call the `getIamPolicy` method on the target resource. For example, to view grants for a project, call the [projects.getIamPolicy](/resource-manager/reference/rest/v1/projects/getIamPolicy) method. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/serviceAccounts/my-service-account', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2615,6 +3704,66 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.list * @desc Lists ServiceAccounts for a project. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Required. The resource name of the project associated with the service + * // accounts, such as `projects/my-project-123`. + * name: 'projects/my-project', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var accountsPage = response['accounts']; + * if (!accountsPage) { + * return; + * } + * for (var i = 0; i < accountsPage.length; i++) { + * // TODO: Change code below to process each resource in `accountsPage`: + * console.log(JSON.stringify(accountsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * iam.projects.serviceAccounts.list(request, handlePage); + * } + * }; + * + * iam.projects.serviceAccounts.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.list * @memberOf! () * @@ -2698,6 +3847,63 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.patch * @desc Patches a ServiceAccount. Currently, only the following fields are updatable: `display_name` and `description`. Only fields specified in the request are guaranteed to be returned in the response. Other fields in the response may be empty. Note: The field mask is required. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the service account in the following format: + * // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. + * // Requests using `-` as a wildcard for the `PROJECT_ID` will infer the + * // project from the `account` and the `ACCOUNT` value can be the `email` + * // address or the `unique_id` of the service account. + * // In responses the resource name will always be in the format + * // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. + * name: 'projects/my-project/serviceAccounts/my-service-account', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.patch * @memberOf! () * @@ -2770,6 +3976,57 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.setIamPolicy * @desc Sets the Cloud IAM access control policy for a ServiceAccount. Note: Service accounts are both [resources and identities](/iam/docs/service-accounts#service_account_permissions). This method treats the service account as a resource. Use it to grant members access to the service account, such as when they need to impersonate it. This method does not grant the service account access to other resources, such as projects. To grant a service account access to resources, include the service account in the Cloud IAM policy for the desired resource, then call the appropriate `setIamPolicy` method on the target resource. For example, to grant a service account access to a project, call the [projects.setIamPolicy](/resource-manager/reference/rest/v1/projects/setIamPolicy) method. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/serviceAccounts/my-service-account', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.setIamPolicy * @memberOf! () * @@ -2843,6 +4100,60 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.signBlob * @desc **Note**: This method is in the process of being deprecated. Call the [`signBlob()`](/iam/credentials/reference/rest/v1/projects.serviceAccounts/signBlob) method of the Cloud IAM Service Account Credentials API instead. Signs a blob using a service account's system-managed private key. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the service account in the following format: + * // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. + * // Using `-` as a wildcard for the `PROJECT_ID` will infer the project from + * // the account. The `ACCOUNT` value can be the `email` address or the + * // `unique_id` of the service account. + * name: 'projects/my-project/serviceAccounts/my-service-account', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.signBlob(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.signBlob * @memberOf! () * @@ -2918,6 +4229,60 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.signJwt * @desc **Note**: This method is in the process of being deprecated. Call the [`signJwt()`](/iam/credentials/reference/rest/v1/projects.serviceAccounts/signJwt) method of the Cloud IAM Service Account Credentials API instead. Signs a JWT using a service account's system-managed private key. If no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an an expiry time of one hour by default. If you request an expiry time of more than one hour, the request will fail. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the service account in the following format: + * // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. + * // Using `-` as a wildcard for the `PROJECT_ID` will infer the project from + * // the account. The `ACCOUNT` value can be the `email` address or the + * // `unique_id` of the service account. + * name: 'projects/my-project/serviceAccounts/my-service-account', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.signJwt(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.signJwt * @memberOf! () * @@ -2993,6 +4358,57 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.testIamPermissions * @desc Tests the specified permissions against the IAM access control policy for a ServiceAccount. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'projects/my-project/serviceAccounts/my-service-account', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.testIamPermissions * @memberOf! () * @@ -3075,6 +4491,59 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.undelete * @desc Restores a deleted ServiceAccount. This is to be used as an action of last resort. A service account may not always be restorable. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the service account in the following format: + * // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_UNIQUE_ID}'. + * // Using `-` as a wildcard for the `PROJECT_ID` will infer the project from + * // the account. + * name: 'projects/my-project/serviceAccounts/my-service-account', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.undelete(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.undelete * @memberOf! () * @@ -3159,6 +4628,63 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.update * @desc Note: This method is in the process of being deprecated. Use PatchServiceAccount instead. Updates a ServiceAccount. Currently, only the following fields are updatable: `display_name` and `description`. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the service account in the following format: + * // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. + * // Requests using `-` as a wildcard for the `PROJECT_ID` will infer the + * // project from the `account` and the `ACCOUNT` value can be the `email` + * // address or the `unique_id` of the service account. + * // In responses the resource name will always be in the format + * // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. + * name: 'projects/my-project/serviceAccounts/my-service-account', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.update * @memberOf! () * @@ -3311,6 +4837,10 @@ export namespace iam_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ @@ -3465,6 +4995,60 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.keys.create * @desc Creates a ServiceAccountKey and returns it. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the service account in the following format: + * // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. + * // Using `-` as a wildcard for the `PROJECT_ID` will infer the project from + * // the account. The `ACCOUNT` value can be the `email` address or the + * // `unique_id` of the service account. + * name: 'projects/my-project/serviceAccounts/my-service-account', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.keys.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.keys.create * @memberOf! () * @@ -3537,6 +5121,53 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.keys.delete * @desc Deletes a ServiceAccountKey. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the service account key in the following format: + * // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. + * // Using `-` as a wildcard for the `PROJECT_ID` will infer the project from + * // the account. The `ACCOUNT` value can be the `email` address or the + * // `unique_id` of the service account. + * name: 'projects/my-project/serviceAccounts/my-service-account/keys/my-key', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.keys.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.keys.delete * @memberOf! () * @@ -3606,6 +5237,56 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.keys.get * @desc Gets the ServiceAccountKey by key id. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the service account key in the following format: + * // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. + * // Using `-` as a wildcard for the `PROJECT_ID` will infer the project from + * // the account. The `ACCOUNT` value can be the `email` address or the + * // `unique_id` of the service account. + * name: 'projects/my-project/serviceAccounts/my-service-account/keys/my-key', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.keys.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.keys.get * @memberOf! () * @@ -3678,6 +5359,56 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.keys.list * @desc Lists ServiceAccountKeys. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the service account in the following format: + * // `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. + * // Using `-` as a wildcard for the `PROJECT_ID`, will infer the project from + * // the account. The `ACCOUNT` value can be the `email` address or the + * // `unique_id` of the service account. + * name: 'projects/my-project/serviceAccounts/my-service-account', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * iam.projects.serviceAccounts.keys.list(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.projects.serviceAccounts.keys.list * @memberOf! () * @@ -3828,11 +5559,60 @@ export namespace iam_v1 { /** * iam.roles.get * @desc Gets a Role definition. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the role in one of the following formats: + * // `roles/{ROLE_NAME}` + * // `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` + * // `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * name: 'roles/my-role', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * iam.roles.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.roles.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * @param {string} params.name The `name` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization 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 @@ -3896,13 +5676,69 @@ export namespace iam_v1 { /** * iam.roles.list * @desc Lists the Roles defined on a resource. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var rolesPage = response['roles']; + * if (!rolesPage) { + * return; + * } + * for (var i = 0; i < rolesPage.length; i++) { + * // TODO: Change code below to process each resource in `rolesPage`: + * console.log(JSON.stringify(rolesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * iam.roles.list(request, handlePage); + * } + * }; + * + * iam.roles.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.roles.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize Optional limit on the number of roles to include in the response. * @param {string=} params.pageToken Optional pagination token returned in an earlier ListRolesResponse. - * @param {string=} params.parent The resource name of the parent resource in one of the following formats: `` (empty string) -- this refers to curated roles. `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` + * @param {string=} params.parent The `parent` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. * @param {boolean=} params.showDeleted Include Roles that have been deleted. * @param {string=} params.view Optional view for the returned Role objects. When `FULL` is specified, the `includedPermissions` field is returned, which includes a list of all permissions in the role. The default value is `BASIC`, which does not return the `includedPermissions` field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3970,6 +5806,66 @@ export namespace iam_v1 { /** * iam.roles.queryGrantableRoles * @desc Queries roles that can be granted on a particular resource. A role is grantable if it can be used as the role in a binding for a policy for that resource. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Identity and Access Management (IAM) API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/iam + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var iam = google.iam('v1'); + * + * authorize(function(authClient) { + * var request = { + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var rolesPage = response['roles']; + * if (!rolesPage) { + * return; + * } + * for (var i = 0; i < rolesPage.length; i++) { + * // TODO: Change code below to process each resource in `rolesPage`: + * console.log(JSON.stringify(rolesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.resource.pageToken = response.nextPageToken; + * iam.roles.queryGrantableRoles(request, handlePage); + * } + * }; + * + * iam.roles.queryGrantableRoles(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias iam.roles.queryGrantableRoles * @memberOf! () * @@ -4056,7 +5952,7 @@ export namespace iam_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}` + * The `name` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */ name?: string; } @@ -4075,7 +5971,7 @@ export namespace iam_v1 { */ pageToken?: string; /** - * The resource name of the parent resource in one of the following formats: `` (empty string) -- this refers to curated roles. `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}` + * The `parent` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. */ parent?: string; /** diff --git a/src/apis/iam/webpack.config.js b/src/apis/iam/webpack.config.js index a8edb1eaa2a..a6fdafb16ed 100644 --- a/src/apis/iam/webpack.config.js +++ b/src/apis/iam/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/iamcredentials/package.json b/src/apis/iamcredentials/package.json index c751aecb044..dd38aa1711d 100644 --- a/src/apis/iamcredentials/package.json +++ b/src/apis/iamcredentials/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/iamcredentials/webpack.config.js b/src/apis/iamcredentials/webpack.config.js index a975931466f..84c405e6d75 100644 --- a/src/apis/iamcredentials/webpack.config.js +++ b/src/apis/iamcredentials/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/iap/package.json b/src/apis/iap/package.json index 80705a5a7d5..5a20edcc56f 100644 --- a/src/apis/iap/package.json +++ b/src/apis/iap/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/iap/v1.ts b/src/apis/iap/v1.ts index 1a7d7a69711..9518de83736 100644 --- a/src/apis/iap/v1.ts +++ b/src/apis/iap/v1.ts @@ -126,7 +126,7 @@ export namespace iap_v1 { */ 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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * 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@example.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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** @@ -158,7 +158,21 @@ export namespace iap_v1 { /** * Request message for `GetIamPolicy` method. */ - export interface Schema$GetIamPolicyRequest {} + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + */ + options?: Schema$GetPolicyOptions; + } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + requestedPolicyVersion?: number; + } /** * 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). */ @@ -168,7 +182,7 @@ export namespace iap_v1 { */ 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` 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. */ etag?: string; /** diff --git a/src/apis/iap/v1beta1.ts b/src/apis/iap/v1beta1.ts index 0d91480c677..316bddb1d57 100644 --- a/src/apis/iap/v1beta1.ts +++ b/src/apis/iap/v1beta1.ts @@ -158,7 +158,21 @@ export namespace iap_v1beta1 { /** * Request message for `GetIamPolicy` method. */ - export interface Schema$GetIamPolicyRequest {} + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + */ + options?: Schema$GetPolicyOptions; + } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + requestedPolicyVersion?: number; + } /** * 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). */ diff --git a/src/apis/iap/webpack.config.js b/src/apis/iap/webpack.config.js index d6281c03f1b..0e8c36a16f8 100644 --- a/src/apis/iap/webpack.config.js +++ b/src/apis/iap/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/identitytoolkit/package.json b/src/apis/identitytoolkit/package.json index 17587d2da19..be54d3a4db2 100644 --- a/src/apis/identitytoolkit/package.json +++ b/src/apis/identitytoolkit/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/identitytoolkit/webpack.config.js b/src/apis/identitytoolkit/webpack.config.js index 2f26368011a..d5c30cd170c 100644 --- a/src/apis/identitytoolkit/webpack.config.js +++ b/src/apis/identitytoolkit/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/index.ts b/src/apis/index.ts index 64453ac255e..c9e3eec36b1 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -85,7 +85,9 @@ import * as doubleclicksearch from './doubleclicksearch'; import * as drive from './drive'; import * as driveactivity from './driveactivity'; import * as factchecktools from './factchecktools'; +import * as fcm from './fcm'; import * as file from './file'; +import * as firebase from './firebase'; import * as firebasedynamiclinks from './firebasedynamiclinks'; import * as firebasehosting from './firebasehosting'; import * as firebaserules from './firebaserules'; @@ -248,7 +250,9 @@ export const APIS: APIList = { drive: drive.VERSIONS, driveactivity: driveactivity.VERSIONS, factchecktools: factchecktools.VERSIONS, + fcm: fcm.VERSIONS, file: file.VERSIONS, + firebase: firebase.VERSIONS, firebasedynamiclinks: firebasedynamiclinks.VERSIONS, firebasehosting: firebasehosting.VERSIONS, firebaserules: firebaserules.VERSIONS, @@ -409,7 +413,9 @@ export class GeneratedAPIs { drive = drive.drive; driveactivity = driveactivity.driveactivity; factchecktools = factchecktools.factchecktools; + fcm = fcm.fcm; file = file.file; + firebase = firebase.firebase; firebasedynamiclinks = firebasedynamiclinks.firebasedynamiclinks; firebasehosting = firebasehosting.firebasehosting; firebaserules = firebaserules.firebaserules; diff --git a/src/apis/indexing/package.json b/src/apis/indexing/package.json index 3a5d9f97e92..0da39f3e4ca 100644 --- a/src/apis/indexing/package.json +++ b/src/apis/indexing/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/indexing/webpack.config.js b/src/apis/indexing/webpack.config.js index 41bfc285375..8b8c1871111 100644 --- a/src/apis/indexing/webpack.config.js +++ b/src/apis/indexing/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/jobs/package.json b/src/apis/jobs/package.json index f73e081d124..168f6ce822a 100644 --- a/src/apis/jobs/package.json +++ b/src/apis/jobs/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/jobs/v2.ts b/src/apis/jobs/v2.ts index 4017e157ebd..bd30add6412 100644 --- a/src/apis/jobs/v2.ts +++ b/src/apis/jobs/v2.ts @@ -321,7 +321,7 @@ export namespace jobs_v2 { */ type?: string; /** - * Optional. Frequency of the specified amount. Default is CompensationUnit.OTHER_COMPENSATION_UNIT. + * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. */ unit?: string; } @@ -664,7 +664,7 @@ export namespace jobs_v2 { */ type?: string; /** - * Optional. Frequency of the specified amount. Default is CompensationUnit.OTHER_COMPENSATION_UNIT. + * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. */ unit?: string; /** diff --git a/src/apis/jobs/v3.ts b/src/apis/jobs/v3.ts index e497579c982..e5a874f0cac 100644 --- a/src/apis/jobs/v3.ts +++ b/src/apis/jobs/v3.ts @@ -327,11 +327,11 @@ export namespace jobs_v3 { */ range?: Schema$CompensationRange; /** - * Optional. Compensation type. Default is CompensationUnit.OTHER_COMPENSATION_TYPE. + * Optional. Compensation type. Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. */ type?: string; /** - * Optional. Frequency of the specified amount. Default is CompensationUnit.OTHER_COMPENSATION_UNIT. + * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. */ unit?: string; } @@ -340,7 +340,7 @@ export namespace jobs_v3 { */ export interface Schema$CompensationFilter { /** - * Optional. Whether to include jobs whose compensation range is unspecified. + * Optional. If set to true, jobs with unspecified compensation range fields are included. */ includeJobsWithUnspecifiedCompensationRange?: boolean; /** @@ -877,7 +877,7 @@ export namespace jobs_v3 { */ regionCode?: string; /** - * Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecomuting is considered by the service as a special location. Job.posting_region indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. + * Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecommuting is considered by the service as a special location. Job.posting_region indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. */ telecommutePreference?: string; } @@ -1078,7 +1078,7 @@ export namespace jobs_v3 { */ offset?: number; /** - * Optional. The criteria determining how search results are sorted. Default is "relevance desc". Supported options are: * "relevance desc": By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering. * "posting`_`publish`_`time desc": By Job.posting_publish_time descending. * "posting`_`update`_`time desc": By Job.posting_update_time descending. * "title": By Job.title ascending. * "title desc": By Job.title descending. * "annualized`_`base`_`compensation": By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * "annualized`_`base`_`compensation desc": By job's CompensationInfo.annualized_base_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * "annualized`_`total`_`compensation": By job's CompensationInfo.annualized_total_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * "annualized`_`total`_`compensation desc": By job's CompensationInfo.annualized_total_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. + * Optional. The criteria determining how search results are sorted. Default is "relevance desc". Supported options are: * `"relevance desc"`: By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering. * `"posting_publish_time desc"`: By Job.posting_publish_time descending. * `"posting_update_time desc"`: By Job.posting_update_time descending. * `"title"`: By Job.title ascending. * `"title desc"`: By Job.title descending. * `"annualized_base_compensation"`: By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_base_compensation desc"`: By job's CompensationInfo.annualized_base_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_total_compensation"`: By job's CompensationInfo.annualized_total_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_total_compensation desc"`: By job's CompensationInfo.annualized_total_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. */ orderBy?: string; /** @@ -1090,7 +1090,7 @@ export namespace jobs_v3 { */ pageToken?: string; /** - * Required. The meta information collected about the job searcher, used to improve the search quality of the service.. The identifiers, (such as `user_id`) are provided by users, and must be unique and consistent. + * Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers (such as `user_id`) are provided by users, and must be unique and consistent. */ requestMetadata?: Schema$RequestMetadata; /** diff --git a/src/apis/jobs/v3p1beta1.ts b/src/apis/jobs/v3p1beta1.ts index e67edfeb3c2..2de4211f56c 100644 --- a/src/apis/jobs/v3p1beta1.ts +++ b/src/apis/jobs/v3p1beta1.ts @@ -327,11 +327,11 @@ export namespace jobs_v3p1beta1 { */ range?: Schema$CompensationRange; /** - * Optional. Compensation type. Default is CompensationUnit.OTHER_COMPENSATION_TYPE. + * Optional. Compensation type. Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. */ type?: string; /** - * Optional. Frequency of the specified amount. Default is CompensationUnit.OTHER_COMPENSATION_UNIT. + * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. */ unit?: string; } @@ -340,7 +340,7 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$CompensationFilter { /** - * Optional. Whether to include jobs whose compensation range is unspecified. + * Optional. If set to true, jobs with unspecified compensation range fields are included. */ includeJobsWithUnspecifiedCompensationRange?: boolean; /** @@ -803,7 +803,7 @@ export namespace jobs_v3p1beta1 { */ employmentTypes?: string[]; /** - * Optional. This filter specifies a list of job names to be excluded during search. At most 200 excluded job names are allowed. + * Optional. This filter specifies a list of job names to be excluded during search. At most 400 excluded job names are allowed. */ excludedJobs?: string[]; /** @@ -916,7 +916,7 @@ export namespace jobs_v3p1beta1 { */ regionCode?: string; /** - * Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecomuting is considered by the service as a special location. Job.posting_region indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. + * Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecommuting is considered by the service as a special location. Job.posting_region indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. */ telecommutePreference?: string; } @@ -1150,7 +1150,7 @@ export namespace jobs_v3p1beta1 { */ offset?: number; /** - * Optional. The criteria determining how search results are sorted. Default is "relevance desc". Supported options are: * "relevance desc": By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering. * "posting`_`publish`_`time desc": By Job.posting_publish_time descending. * "posting`_`update`_`time desc": By Job.posting_update_time descending. * "title": By Job.title ascending. * "title desc": By Job.title descending. * "annualized`_`base`_`compensation": By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * "annualized`_`base`_`compensation desc": By job's CompensationInfo.annualized_base_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * "annualized`_`total`_`compensation": By job's CompensationInfo.annualized_total_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * "annualized`_`total`_`compensation desc": By job's CompensationInfo.annualized_total_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * "custom`_`ranking desc": By the relevance score adjusted to the SearchJobsRequest.custom_ranking_info.ranking_expression with weight factor assigned by SearchJobsRequest.custom_ranking_info.importance_level in descending order. * "location`_`distance": By the distance between the location on jobs and locations specified in the SearchJobsRequest.job_query.location_filters. When this order is selected, the SearchJobsRequest.job_query.location_filters must not be empty. When a job has multiple locations, the location closest to one of the locations specified in the location filter will be used to calculate location distance. Distance is calculated by the distance between two lat/long coordinates, with a precision of 10e-4 degrees (11.3 meters). Jobs that don't have locations specified will be ranked below jobs having locations. Diversification strategy is still applied unless explicitly disabled in SearchJobsRequest.diversification_level. + * Optional. The criteria determining how search results are sorted. Default is "relevance desc". Supported options are: * `"relevance desc"`: By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering. * `"posting_publish_time desc"`: By Job.posting_publish_time descending. * `"posting_update_time desc"`: By Job.posting_update_time descending. * `"title"`: By Job.title ascending. * `"title desc"`: By Job.title descending. * `"annualized_base_compensation"`: By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_base_compensation desc"`: By job's CompensationInfo.annualized_base_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_total_compensation"`: By job's CompensationInfo.annualized_total_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"annualized_total_compensation desc"`: By job's CompensationInfo.annualized_total_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `"custom_ranking desc"`: By the relevance score adjusted to the SearchJobsRequest.custom_ranking_info.ranking_expression with weight factor assigned by SearchJobsRequest.custom_ranking_info.importance_level in descending order. * Location sorting: Use the special syntax to order jobs by distance:<br> "`distance_from('Hawaii')`": Order by distance from Hawaii.<br> "`distance_from(19.89, 155.5)`": Order by distance from a coordinate.<br> "`distance_from('Hawaii'), distance_from('Puerto Rico')`": Order by multiple locations. See details below.<br> "`distance_from('Hawaii'), distance_from(19.89, 155.5)`": Order by multiple locations. See details below.<br> The string can have a maximum of 256 characters. When multiple distance centers are provided, a job that is close to any of the distance centers would have a high rank. When a job has multiple locations, the job location closest to one of the distance centers will be used. Jobs that don't have locations will be ranked at the bottom. Distance is calculated with a precision of 11.3 meters (37.4 feet). Diversification strategy is still applied unless explicitly disabled in diversification_level. */ orderBy?: string; /** @@ -1162,7 +1162,7 @@ export namespace jobs_v3p1beta1 { */ pageToken?: string; /** - * Required. The meta information collected about the job searcher, used to improve the search quality of the service.. The identifiers, (such as `user_id`) are provided by users, and must be unique and consistent. + * Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers (such as `user_id`) are provided by users, and must be unique and consistent. */ requestMetadata?: Schema$RequestMetadata; /** @@ -1233,7 +1233,7 @@ export namespace jobs_v3p1beta1 { correctedText?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/jobs/webpack.config.js b/src/apis/jobs/webpack.config.js index ed5d637669b..26278dd60ff 100644 --- a/src/apis/jobs/webpack.config.js +++ b/src/apis/jobs/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/kgsearch/package.json b/src/apis/kgsearch/package.json index 9b90f17b045..b8c572ec83c 100644 --- a/src/apis/kgsearch/package.json +++ b/src/apis/kgsearch/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/kgsearch/webpack.config.js b/src/apis/kgsearch/webpack.config.js index 26a999ef619..9767bc2775f 100644 --- a/src/apis/kgsearch/webpack.config.js +++ b/src/apis/kgsearch/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/language/package.json b/src/apis/language/package.json index 23066934609..f22d8b5428f 100644 --- a/src/apis/language/package.json +++ b/src/apis/language/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/language/v1.ts b/src/apis/language/v1.ts index 41f8dbd6ab8..9e174b34c62 100644 --- a/src/apis/language/v1.ts +++ b/src/apis/language/v1.ts @@ -491,7 +491,7 @@ export namespace language_v1 { score?: number; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/language/v1beta1.ts b/src/apis/language/v1beta1.ts index a69d81424d7..8afeedd0abd 100644 --- a/src/apis/language/v1beta1.ts +++ b/src/apis/language/v1beta1.ts @@ -418,7 +418,7 @@ export namespace language_v1beta1 { score?: number; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/language/v1beta2.ts b/src/apis/language/v1beta2.ts index 43f606e71c4..d2b2c1f3cc8 100644 --- a/src/apis/language/v1beta2.ts +++ b/src/apis/language/v1beta2.ts @@ -491,7 +491,7 @@ export namespace language_v1beta2 { score?: number; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/language/webpack.config.js b/src/apis/language/webpack.config.js index 91cc0cd8909..a35b71ced74 100644 --- a/src/apis/language/webpack.config.js +++ b/src/apis/language/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/libraryagent/package.json b/src/apis/libraryagent/package.json index d7b0c05d752..86608d41aa6 100644 --- a/src/apis/libraryagent/package.json +++ b/src/apis/libraryagent/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/libraryagent/webpack.config.js b/src/apis/libraryagent/webpack.config.js index 36cea16bd85..656901512c1 100644 --- a/src/apis/libraryagent/webpack.config.js +++ b/src/apis/libraryagent/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/licensing/package.json b/src/apis/licensing/package.json index 28be9393110..d4fbc7e20e5 100644 --- a/src/apis/licensing/package.json +++ b/src/apis/licensing/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/licensing/webpack.config.js b/src/apis/licensing/webpack.config.js index df20108cbff..ce010edfaae 100644 --- a/src/apis/licensing/webpack.config.js +++ b/src/apis/licensing/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/logging/README.md b/src/apis/logging/README.md index 729b87c63fb..914d7118269 100644 --- a/src/apis/logging/README.md +++ b/src/apis/logging/README.md @@ -2,7 +2,7 @@ # logging -> Writes log entries and manages your Logging configuration. +> Writes log entries and manages your Stackdriver Logging configuration. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the [Stackdriver Logging documentation](/logging/docs). ## Installation diff --git a/src/apis/logging/package.json b/src/apis/logging/package.json index c7cb63fd0bf..e5d90c360f3 100644 --- a/src/apis/logging/package.json +++ b/src/apis/logging/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index 009f7b74d69..0137c801fad 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -91,7 +91,7 @@ export namespace logging_v2 { /** * Stackdriver Logging API * - * Writes log entries and manages your Logging configuration. + * Writes log entries and manages your Stackdriver Logging configuration. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the Stackdriver Logging documentation. * * @example * const {google} = require('googleapis'); @@ -421,7 +421,7 @@ export namespace logging_v2 { */ operation?: Schema$LogEntryOperation; /** - * The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads. + * The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.The following protocol buffer types are supported; user-defined types are not supported:"type.googleapis.com/google.cloud.audit.AuditLog" "type.googleapis.com/google.appengine.logging.v1.RequestLog" */ protoPayload?: {[key: string]: any}; /** @@ -429,7 +429,7 @@ export namespace logging_v2 { */ receiveTimestamp?: string; /** - * Required. The primary monitored resource associated with this log entry.Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error. + * Required. The monitored resource that produced this log entry.Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error. */ resource?: Schema$MonitoredResource; /** @@ -647,6 +647,10 @@ export namespace logging_v2 { * 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. The launch stage of the metric definition. + */ + launchStage?: string; /** * Optional. Metadata which can be used to guide usage of the metric. */ @@ -681,7 +685,7 @@ export namespace logging_v2 { */ ingestDelay?: string; /** - * The launch stage of the metric definition. + * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. */ launchStage?: string; /** diff --git a/src/apis/logging/webpack.config.js b/src/apis/logging/webpack.config.js index fb6e7b441b3..c19600af9d0 100644 --- a/src/apis/logging/webpack.config.js +++ b/src/apis/logging/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/manufacturers/package.json b/src/apis/manufacturers/package.json index 05a3e9e44ca..03348db3733 100644 --- a/src/apis/manufacturers/package.json +++ b/src/apis/manufacturers/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/manufacturers/webpack.config.js b/src/apis/manufacturers/webpack.config.js index 2705af8f786..4bfd3b638de 100644 --- a/src/apis/manufacturers/webpack.config.js +++ b/src/apis/manufacturers/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/mirror/package.json b/src/apis/mirror/package.json index d7a030f1612..488169efbf2 100644 --- a/src/apis/mirror/package.json +++ b/src/apis/mirror/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/mirror/webpack.config.js b/src/apis/mirror/webpack.config.js index 619aae6ef39..b4c4b1c74fe 100644 --- a/src/apis/mirror/webpack.config.js +++ b/src/apis/mirror/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/ml/package.json b/src/apis/ml/package.json index 13884c390b6..520e03bcea1 100644 --- a/src/apis/ml/package.json +++ b/src/apis/ml/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/ml/v1.ts b/src/apis/ml/v1.ts index 4760f10aa01..39d1b74b0fd 100644 --- a/src/apis/ml/v1.ts +++ b/src/apis/ml/v1.ts @@ -105,7 +105,6 @@ export namespace ml_v1 { */ export class Ml { context: APIRequestContext; - operations: Resource$Operations; projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -114,7 +113,6 @@ export namespace ml_v1 { google, }; - this.operations = new Resource$Operations(this.context); this.projects = new Resource$Projects(this.context); } } @@ -188,7 +186,7 @@ export namespace ml_v1 { */ pythonVersion?: string; /** - * Cloud ML Engine runtime version on which the built-in algorithm was trained. + * AI Platform runtime version on which the built-in algorithm was trained. */ runtimeVersion?: string; } @@ -235,6 +233,10 @@ export namespace ml_v1 { * Details related to built-in algorithms jobs. Only set for trials of built-in algorithms jobs that have succeeded. */ builtInAlgorithmOutput?: Schema$GoogleCloudMlV1__BuiltInAlgorithmOutput; + /** + * Output only. End time for the trial. + */ + endTime?: string; /** * The final objective metric seen for this trial. */ @@ -247,6 +249,14 @@ export namespace ml_v1 { * True if the trial is stopped early. */ isTrialStoppedEarly?: boolean; + /** + * Output only. Start time for the trial. + */ + startTime?: string; + /** + * Output only. The detailed state of the trial. + */ + state?: string; /** * The trial id for these results. */ @@ -257,7 +267,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__HyperparameterSpec { /** - * Optional. The search algorithm specified for the hyperparameter tuning job. Uses the default CloudML Engine hyperparameter tuning algorithm if unspecified. + * Optional. The search algorithm specified for the hyperparameter tuning job. Uses the default AI Platform hyperparameter tuning algorithm if unspecified. */ algorithm?: string; /** @@ -269,11 +279,11 @@ export namespace ml_v1 { */ goal?: string; /** - * Optional. The Tensorflow summary tag name to use for optimizing trials. For current versions of Tensorflow, this tag name should exactly match what is shown in Tensorboard, including all scopes. For versions of Tensorflow prior to 0.12, this should be only the tag passed to tf.Summary. By default, "training/hptuning/metric" will be used. + * Optional. The TensorFlow summary tag name to use for optimizing trials. For current versions of TensorFlow, this tag name should exactly match what is shown in TensorBoard, including all scopes. For versions of TensorFlow prior to 0.12, this should be only the tag passed to tf.Summary. By default, "training/hptuning/metric" will be used. */ hyperparameterMetricTag?: string; /** - * Optional. The number of failed trials that need to be seen before failing the hyperparameter tuning job. You can specify this field to override the default failing criteria for Cloud ML Engine hyperparameter tuning jobs. Defaults to zero, which means the service decides when a hyperparameter job should fail. + * Optional. The number of failed trials that need to be seen before failing the hyperparameter tuning job. You can specify this field to override the default failing criteria for AI Platform hyperparameter tuning jobs. Defaults to zero, which means the service decides when a hyperparameter job should fail. */ maxFailedTrials?: number; /** @@ -436,15 +446,15 @@ export namespace ml_v1 { */ name?: string; /** - * Optional. If true, enables logging of stderr and stdout streams for online prediction in Stackdriver Logging. These can be more verbose than the standard access logs (see `online_prediction_logging`) and thus can incur higher cost. However, they are helpful for debugging. Note that since Stackdriver logs may incur a cost, particularly if the total QPS in your project is high, be sure to estimate your costs before enabling this flag. Default is false. + * Optional. If true, online prediction nodes send `stderr` and `stdout` streams to Stackdriver Logging. These can be more verbose than the standard access logs (see `onlinePredictionLogging`) and can incur higher cost. However, they are helpful for debugging. Note that [Stackdriver logs may incur a cost](/stackdriver/pricing), especially if your project receives prediction requests at a high QPS. Estimate your costs before enabling this option. Default is false. */ onlinePredictionConsoleLogging?: boolean; /** - * Optional. If true, online prediction access logs are sent to StackDriver Logging. These logs are like standard server access logs, containing information like timestamp and latency for each request. Note that Stackdriver logs may incur a cost, particular if the total QPS in your project is high. Default is false. + * Optional. If true, online prediction access logs are sent to StackDriver Logging. These logs are like standard server access logs, containing information like timestamp and latency for each request. Note that [Stackdriver logs may incur a cost](/stackdriver/pricing), especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. Default is false. */ onlinePredictionLogging?: boolean; /** - * Optional. The list of regions where the model is going to be deployed. Currently only one region per model is supported. Defaults to 'us-central1' if nothing is set. See the <a href="/ml-engine/docs/tensorflow/regions">available regions</a> for ML Engine services. Note: * No matter where a model is deployed, it can always be accessed by users from anywhere, both for online and batch prediction. * The region for a batch prediction job is set by the region field when submitting the batch prediction job and does not take its value from this field. + * Optional. The list of regions where the model is going to be deployed. Currently only one region per model is supported. Defaults to 'us-central1' if nothing is set. See the <a href="/ml-engine/docs/tensorflow/regions">available regions</a> for AI Platform services. Note: * No matter where a model is deployed, it can always be accessed by users from anywhere, both for online and batch prediction. * The region for a batch prediction job is set by the region field when submitting the batch prediction job and does not take its value from this field. */ regions?: string[]; } @@ -555,11 +565,11 @@ export namespace ml_v1 { */ outputPath?: string; /** - * Required. The Google Compute Engine region to run the prediction job in. See the <a href="/ml-engine/docs/tensorflow/regions">available regions</a> for ML Engine services. + * Required. The Google Compute Engine region to run the prediction job in. See the <a href="/ml-engine/docs/tensorflow/regions">available regions</a> for AI Platform services. */ region?: string; /** - * Optional. The Cloud ML Engine runtime version to use for this batch prediction. If not set, Cloud ML Engine will pick the runtime version used during the CreateVersion request for this model version, or choose the latest stable version when model version information is not available such as when the model is specified by uri. + * Optional. The AI Platform runtime version to use for this batch prediction. If not set, AI Platform will pick the runtime version used during the CreateVersion request for this model version, or choose the latest stable version when model version information is not available such as when the model is specified by uri. */ runtimeVersion?: string; /** @@ -617,6 +627,10 @@ export namespace ml_v1 { * The Docker image to run on the replica. This image must be in Container Registry. Learn more about [configuring custom containers](/ml-engine/docs/distributed-training-containers). */ imageUri?: string; + /** + * TensorFlow version used in the custom container. This field is required if the replica is a TPU worker that uses a custom container. Otherwise, do not specify this field. + */ + tpuTfVersion?: string; } /** * Request message for the SetDefaultVersion request. @@ -646,12 +660,16 @@ export namespace ml_v1 { * Optional. Specifies the type of virtual machine to use for your training job's master worker. The following types are supported: <dl> <dt>standard</dt> <dd> A basic machine configuration suitable for training simple models with small to moderate datasets. </dd> <dt>large_model</dt> <dd> A machine with a lot of memory, specially suited for parameter servers when your model is large (having many hidden layers or layers with very large numbers of nodes). </dd> <dt>complex_model_s</dt> <dd> A machine suitable for the master and workers of the cluster when your model requires more computation than the standard machine can handle satisfactorily. </dd> <dt>complex_model_m</dt> <dd> A machine with roughly twice the number of cores and roughly double the memory of <i>complex_model_s</i>. </dd> <dt>complex_model_l</dt> <dd> A machine with roughly twice the number of cores and roughly double the memory of <i>complex_model_m</i>. </dd> <dt>standard_gpu</dt> <dd> A machine equivalent to <i>standard</i> that also includes a single NVIDIA Tesla K80 GPU. See more about <a href="/ml-engine/docs/tensorflow/using-gpus">using GPUs to train your model</a>. </dd> <dt>complex_model_m_gpu</dt> <dd> A machine equivalent to <i>complex_model_m</i> that also includes four NVIDIA Tesla K80 GPUs. </dd> <dt>complex_model_l_gpu</dt> <dd> A machine equivalent to <i>complex_model_l</i> that also includes eight NVIDIA Tesla K80 GPUs. </dd> <dt>standard_p100</dt> <dd> A machine equivalent to <i>standard</i> that also includes a single NVIDIA Tesla P100 GPU. </dd> <dt>complex_model_m_p100</dt> <dd> A machine equivalent to <i>complex_model_m</i> that also includes four NVIDIA Tesla P100 GPUs. </dd> <dt>standard_v100</dt> <dd> A machine equivalent to <i>standard</i> that also includes a single NVIDIA Tesla V100 GPU. </dd> <dt>large_model_v100</dt> <dd> A machine equivalent to <i>large_model</i> that also includes a single NVIDIA Tesla V100 GPU. </dd> <dt>complex_model_m_v100</dt> <dd> A machine equivalent to <i>complex_model_m</i> that also includes four NVIDIA Tesla V100 GPUs. </dd> <dt>complex_model_l_v100</dt> <dd> A machine equivalent to <i>complex_model_l</i> that also includes eight NVIDIA Tesla V100 GPUs. </dd> <dt>cloud_tpu</dt> <dd> A TPU VM including one Cloud TPU. See more about <a href="/ml-engine/docs/tensorflow/using-tpus">using TPUs to train your model</a>. </dd> </dl> You may also use certain Compute Engine machine types directly in this field. The following types are supported: - `n1-standard-4` - `n1-standard-8` - `n1-standard-16` - `n1-standard-32` - `n1-standard-64` - `n1-standard-96` - `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` - `n1-highmem-16` - `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16` - `n1-highcpu-32` - `n1-highcpu-64` - `n1-highcpu-96` See more about [using Compute Engine machine types](/ml-engine/docs/tensorflow/machine-types#compute-engine-machine-types). You must set this value when `scaleTier` is set to `CUSTOM`. */ masterType?: string; + /** + * Optional. The maximum job running time. The default is 7 days. + */ + maxRunningTime?: string; /** * Required. The Google Cloud Storage location of the packages with the training program and any additional dependencies. The maximum number of package URIs is 100. */ packageUris?: string[]; /** - * Optional. The configuration for parameter servers. You should only set `parameterServerConfig.acceleratorConfig` if `parameterServerConfigType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ml-engine/docs/tensorflow/using-gpus#compute-engine-machine-types-with-gpu) Set `parameterServerConfig.imageUri` only if you build a custom image for your parameter server. If `parameterServerConfig.imageUri` has not been set, Cloud ML Engine uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ml-engine/docs/distributed-training-containers). + * Optional. The configuration for parameter servers. You should only set `parameterServerConfig.acceleratorConfig` if `parameterServerConfigType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ml-engine/docs/tensorflow/using-gpus#compute-engine-machine-types-with-gpu) Set `parameterServerConfig.imageUri` only if you build a custom image for your parameter server. If `parameterServerConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ml-engine/docs/distributed-training-containers). */ parameterServerConfig?: Schema$GoogleCloudMlV1__ReplicaConfig; /** @@ -659,7 +677,7 @@ export namespace ml_v1 { */ parameterServerCount?: string; /** - * Optional. Specifies the type of virtual machine to use for your training job's parameter server. The supported values are the same as those described in the entry for `master_type`. This value must be consistent with the category of machine type that `masterType` uses. In other words, both must be Cloud ML Engine machine types or both must be Compute Engine machine types. This value must be present when `scaleTier` is set to `CUSTOM` and `parameter_server_count` is greater than zero. + * Optional. Specifies the type of virtual machine to use for your training job's parameter server. The supported values are the same as those described in the entry for `master_type`. This value must be consistent with the category of machine type that `masterType` uses. In other words, both must be AI Platform machine types or both must be Compute Engine machine types. This value must be present when `scaleTier` is set to `CUSTOM` and `parameter_server_count` is greater than zero. */ parameterServerType?: string; /** @@ -671,11 +689,11 @@ export namespace ml_v1 { */ pythonVersion?: string; /** - * Required. The Google Compute Engine region to run the training job in. See the <a href="/ml-engine/docs/tensorflow/regions">available regions</a> for ML Engine services. + * Required. The Google Compute Engine region to run the training job in. See the <a href="/ml-engine/docs/tensorflow/regions">available regions</a> for AI Platform services. */ region?: string; /** - * Optional. The Cloud ML Engine runtime version to use for training. If not set, Cloud ML Engine uses the default stable version, 1.0. For more information, see the <a href="/ml-engine/docs/runtime-version-list">runtime version list</a> and <a href="/ml-engine/docs/versioning">how to manage runtime versions</a>. + * Optional. The AI Platform runtime version to use for training. If not set, AI Platform uses the default stable version, 1.0. For more information, see the <a href="/ml-engine/docs/runtime-version-list">runtime version list</a> and <a href="/ml-engine/docs/versioning">how to manage runtime versions</a>. */ runtimeVersion?: string; /** @@ -683,7 +701,7 @@ export namespace ml_v1 { */ scaleTier?: string; /** - * Optional. The configuration for workers. You should only set `workerConfig.acceleratorConfig` if `workerType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ml-engine/docs/tensorflow/using-gpus#compute-engine-machine-types-with-gpu) Set `workerConfig.imageUri` only if you build a custom image for your worker. If `workerConfig.imageUri` has not been set, Cloud ML Engine uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ml-engine/docs/distributed-training-containers). + * Optional. The configuration for workers. You should only set `workerConfig.acceleratorConfig` if `workerType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ml-engine/docs/tensorflow/using-gpus#compute-engine-machine-types-with-gpu) Set `workerConfig.imageUri` only if you build a custom image for your worker. If `workerConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ml-engine/docs/distributed-training-containers). */ workerConfig?: Schema$GoogleCloudMlV1__ReplicaConfig; /** @@ -691,7 +709,7 @@ export namespace ml_v1 { */ workerCount?: string; /** - * Optional. Specifies the type of virtual machine to use for your training job's worker nodes. The supported values are the same as those described in the entry for `masterType`. This value must be consistent with the category of machine type that `masterType` uses. In other words, both must be Cloud ML Engine machine types or both must be Compute Engine machine types. If you use `cloud_tpu` for this value, see special instructions for [configuring a custom TPU machine](/ml-engine/docs/tensorflow/using-tpus#configuring_a_custom_tpu_machine). This value must be present when `scaleTier` is set to `CUSTOM` and `workerCount` is greater than zero. + * Optional. Specifies the type of virtual machine to use for your training job's worker nodes. The supported values are the same as those described in the entry for `masterType`. This value must be consistent with the category of machine type that `masterType` uses. In other words, both must be AI Platform machine types or both must be Compute Engine machine types. If you use `cloud_tpu` for this value, see special instructions for [configuring a custom TPU machine](/ml-engine/docs/tensorflow/using-tpus#configuring_a_custom_tpu_machine). This value must be present when `scaleTier` is set to `CUSTOM` and `workerCount` is greater than zero. */ workerType?: string; } @@ -711,6 +729,10 @@ export namespace ml_v1 { * The amount of ML units consumed by the job. */ consumedMLUnits?: number; + /** + * The TensorFlow summary tag name used for optimizing hyperparameter tuning trials. See [`HyperparameterSpec.hyperparameterMetricTag`](#HyperparameterSpec.FIELDS.hyperparameter_metric_tag) for more information. Only set for hyperparameter tuning jobs. + */ + hyperparameterMetricTag?: string; /** * Whether this job is a built-in Algorithm job. */ @@ -725,7 +747,7 @@ export namespace ml_v1 { trials?: Schema$GoogleCloudMlV1__HyperparameterOutput[]; } /** - * Represents a version of the model. Each version is a trained model deployed in the cloud, ready to handle prediction requests. A model can have multiple versions. You can get information about all of the versions of a given model by calling [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list). Next ID: 30 + * Represents a version of the model. Each version is a trained model deployed in the cloud, ready to handle prediction requests. A model can have multiple versions. You can get information about all of the versions of a given model by calling [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list). */ export interface Schema$GoogleCloudMlV1__Version { /** @@ -737,7 +759,7 @@ export namespace ml_v1 { */ createTime?: string; /** - * Required. The Google Cloud Storage location of the trained model used to create the version. See the [guide to model deployment](/ml-engine/docs/tensorflow/deploying-models) for more information. When passing Version to [projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create) the model service uses the specified location as the source of the model. Once deployed, the model version is hosted by the prediction service, so this location is useful only as a historical record. The total number of model files can't exceed 1000. + * Required. The Cloud Storage location of the trained model used to create the version. See the [guide to model deployment](/ml-engine/docs/tensorflow/deploying-models) for more information. When passing Version to [projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create) the model service uses the specified location as the source of the model. Once deployed, the model version is hosted by the prediction service, so this location is useful only as a historical record. The total number of model files can't exceed 1000. */ deploymentUri?: string; /** @@ -753,7 +775,7 @@ export namespace ml_v1 { */ etag?: string; /** - * Optional. The machine learning framework Cloud ML Engine uses to train this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, `XGBOOST`. If you do not specify a framework, Cloud ML Engine will analyze files in the deployment_uri to determine a framework. If you choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version of the model to 1.4 or greater. + * Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, `XGBOOST`. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version of the model to 1.4 or greater. Do **not** specify a framework if you're deploying a [custom prediction routine](/ml-engine/docs/tensorflow/custom-prediction-routines). */ framework?: string; /** @@ -777,15 +799,15 @@ export namespace ml_v1 { */ manualScaling?: Schema$GoogleCloudMlV1__ManualScaling; /** - * Required.The name specified for the version when it was created. The version name must be unique within the model it is created in. + * Required. The name specified for the version when it was created. The version name must be unique within the model it is created in. */ name?: string; /** - * Optional. The Google Cloud Storage location of the packages for custom prediction and any additional dependencies. + * Optional. Cloud Storage paths (`gs://…`) of packages for [custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines) or [scikit-learn pipelines with custom code](/ml-engine/docs/scikit/exporting-for-prediction#custom-pipeline-code). For a custom prediction routine, one of these packages must contain your Predictor class (see [`predictionClass`](#Version.FIELDS.prediction_class)). Additionally, include any dependencies used by your Predictor or scikit-learn pipeline uses that are not already included in your selected [runtime version](/ml-engine/docs/tensorflow/runtime-version-list). If you specify this field, you must also set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater. */ packageUris?: string[]; /** - * class PredictionClass(object): """A Model performs predictions on a given list of instances. The input instances are the raw values sent by the user. It is the responsibility of a Model to translate these instances into actual predictions. The input instances and the output use python data types. The input instances have been decoded prior to being passed to the predict method. The output, which should use python data types is encoded after being returned from the predict method. """ def predict(self, instances, **kwargs): """Returns predictions for the provided instances. Instances are the decoded values from the request. Clients need not worry about decoding json nor base64 decoding. Args: instances: A list of instances, as described in the API. **kwargs: Additional keyword arguments, will be passed into the client's predict method. Returns: A list of outputs containing the prediction results. """ @classmethod def from_path(cls, model_path): """Creates a model using the given model path. Path is useful, e.g., to load files from the exported directory containing the model. Args: model_path: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Model class. """ + * Optional. The fully qualified name (<var>module_name</var>.<var>class_name</var>) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater. The following code sample provides the Predictor interface: ```py class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() ``` Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines). */ predictionClass?: string; /** @@ -793,16 +815,20 @@ export namespace ml_v1 { */ pythonVersion?: string; /** - * Optional. The Cloud ML Engine runtime version to use for this deployment. If not set, Cloud ML Engine uses the default stable version, 1.0. For more information, see the [runtime version list](/ml-engine/docs/runtime-version-list) and [how to manage runtime versions](/ml-engine/docs/versioning). + * Optional. The AI Platform runtime version to use for this deployment. If not set, AI Platform uses the default stable version, 1.0. For more information, see the [runtime version list](/ml-engine/docs/runtime-version-list) and [how to manage runtime versions](/ml-engine/docs/versioning). */ runtimeVersion?: string; + /** + * Optional. Specifies the service account for resource access control. + */ + serviceAccount?: string; /** * Output only. The state of a version. */ state?: string; } /** - * 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. + * 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:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. */ export interface Schema$GoogleIamV1__AuditConfig { /** @@ -815,7 +841,7 @@ export namespace ml_v1 { 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. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. */ export interface Schema$GoogleIamV1__AuditLogConfig { /** @@ -836,7 +862,7 @@ export namespace ml_v1 { */ condition?: Schema$GoogleType__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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * 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@example.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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** @@ -857,7 +883,7 @@ export namespace ml_v1 { */ bindings?: Schema$GoogleIamV1__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` 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. */ etag?: string; /** @@ -926,7 +952,7 @@ export namespace ml_v1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -939,7 +965,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleProtobuf__Empty {} /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$GoogleRpc__Status { /** @@ -977,99 +1003,6 @@ export namespace ml_v1 { title?: string; } - export class Resource$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * ml.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 ml.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 - ): GaxiosPromise; - 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 | GaxiosPromise { - 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://ml.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Operations$Delete - extends StandardParameters { - /** - * 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 class Resource$Projects { context: APIRequestContext; jobs: Resource$Projects$Jobs; @@ -1169,7 +1102,7 @@ export namespace ml_v1 { /** * ml.projects.predict - * @desc Performs prediction on the data in the request. Cloud ML Engine implements a custom `predict` verb on top of an HTTP POST method.

For details of the request and response format, see the **guide to the [predict request format](/ml-engine/docs/v1/predict-request)**. + * @desc Performs prediction on the data in the request. AI Platform implements a custom `predict` verb on top of an HTTP POST method.

For details of the request and response format, see the **guide to the [predict request format](/ml-engine/docs/v1/predict-request)**. * @alias ml.projects.predict * @memberOf! () * @@ -1505,6 +1438,7 @@ export namespace ml_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1955,6 +1889,10 @@ export namespace ml_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ @@ -2494,6 +2432,7 @@ export namespace ml_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2951,6 +2890,10 @@ export namespace ml_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ diff --git a/src/apis/ml/webpack.config.js b/src/apis/ml/webpack.config.js index 8b159b4debc..20122d35209 100644 --- a/src/apis/ml/webpack.config.js +++ b/src/apis/ml/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/monitoring/README.md b/src/apis/monitoring/README.md index f22940758bd..550de19ef41 100644 --- a/src/apis/monitoring/README.md +++ b/src/apis/monitoring/README.md @@ -2,7 +2,7 @@ # monitoring -> Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages. +> Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the [Stackdriver Monitoring documentation](/monitoring/docs). ## Installation diff --git a/src/apis/monitoring/package.json b/src/apis/monitoring/package.json index 5d56beb44be..f118c8f9187 100644 --- a/src/apis/monitoring/package.json +++ b/src/apis/monitoring/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index f10c5342622..7d8ca9c0529 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -91,7 +91,7 @@ export namespace monitoring_v3 { /** * Stackdriver Monitoring API * - * Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages. + * Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the Stackdriver Monitoring documentation. * * @example * const {google} = require('googleapis'); @@ -588,7 +588,7 @@ export namespace monitoring_v3 { useSsl?: boolean; } /** - * An internal checker allows uptime checks to run on private/internal GCP resources.DEPRECATED. Use PrivateChecker instead. + * An internal checker allows uptime checks to run on private/internal GCP resources. */ export interface Schema$InternalChecker { /** @@ -842,6 +842,10 @@ export namespace monitoring_v3 { * 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. The launch stage of the metric definition. + */ + launchStage?: string; /** * Optional. Metadata which can be used to guide usage of the metric. */ @@ -876,7 +880,7 @@ export namespace monitoring_v3 { */ ingestDelay?: string; /** - * The launch stage of the metric definition. + * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. */ launchStage?: string; /** @@ -1130,7 +1134,7 @@ export namespace monitoring_v3 { spanName?: string; } /** - * 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 needsOverviewThe 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 mappingThe 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 usesThe 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. + * 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). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -1156,7 +1160,7 @@ export namespace monitoring_v3 { port?: number; } /** - * A time interval extending just after a start time through an end time. The start time must not be later than the end time. The default start time is the end time, making the startTime value technically optional. Whether this is useful depends on the MetricKind. If the start and end times are the same, the interval represents a point in time. This is appropriate for GAUGE metrics, but not for DELTA and CUMULATIVE metrics, which cover a span of time. + * A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind of the metric value. In no case can the end time be earlier than the start time. For a GAUGE metric, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. For DELTA and CUMULATIVE metrics, the start time must be later than the end time. In all cases, the start time of the next interval must be at least a microsecond after the end time of the previous interval. Because the interval is closed, if the start time of a new interval is the same as the end time of the previous interval, data written at the new start time could overwrite data written at the previous end time. */ export interface Schema$TimeInterval { /** @@ -4854,7 +4858,7 @@ export namespace monitoring_v3 { * @param {string=} params.aggregation.crossSeriesReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. * @param {string=} params.aggregation.groupByFields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored. * @param {string=} params.aggregation.perSeriesAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. - * @param {string=} params.filter A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.label.instance_name = "my-instance-name" + * @param {string=} params.filter A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.labels.instance_name = "my-instance-name" * @param {string=} params.interval.endTime Required. The end of the time interval. * @param {string=} params.interval.startTime Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. * @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}". @@ -4972,7 +4976,7 @@ export namespace monitoring_v3 { */ 'aggregation.perSeriesAligner'?: string; /** - * A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.label.instance_name = "my-instance-name" + * A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.labels.instance_name = "my-instance-name" */ filter?: string; /** diff --git a/src/apis/monitoring/webpack.config.js b/src/apis/monitoring/webpack.config.js index 3ddea9a1c09..50631b8fdff 100644 --- a/src/apis/monitoring/webpack.config.js +++ b/src/apis/monitoring/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/oauth2/package.json b/src/apis/oauth2/package.json index b85b906705d..8e290db5cb0 100644 --- a/src/apis/oauth2/package.json +++ b/src/apis/oauth2/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/oauth2/webpack.config.js b/src/apis/oauth2/webpack.config.js index 2ea59af974b..20f1a8aac75 100644 --- a/src/apis/oauth2/webpack.config.js +++ b/src/apis/oauth2/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/oslogin/package.json b/src/apis/oslogin/package.json index bc5e6ea3505..9c759343ddd 100644 --- a/src/apis/oslogin/package.json +++ b/src/apis/oslogin/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/oslogin/webpack.config.js b/src/apis/oslogin/webpack.config.js index 0f3b7f16817..27f17395d73 100644 --- a/src/apis/oslogin/webpack.config.js +++ b/src/apis/oslogin/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/pagespeedonline/package.json b/src/apis/pagespeedonline/package.json index b519b371c0d..08412e1cc4c 100644 --- a/src/apis/pagespeedonline/package.json +++ b/src/apis/pagespeedonline/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/pagespeedonline/webpack.config.js b/src/apis/pagespeedonline/webpack.config.js index f6e9deba87e..fc9fe049c68 100644 --- a/src/apis/pagespeedonline/webpack.config.js +++ b/src/apis/pagespeedonline/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/people/package.json b/src/apis/people/package.json index f0e216f58d4..b087d31bc21 100644 --- a/src/apis/people/package.json +++ b/src/apis/people/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/people/v1.ts b/src/apis/people/v1.ts index 19980cb5ed1..0e402043dde 100644 --- a/src/apis/people/v1.ts +++ b/src/apis/people/v1.ts @@ -1118,7 +1118,7 @@ export namespace people_v1 { updateTime?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/people/webpack.config.js b/src/apis/people/webpack.config.js index 32ccea223d7..0d29c01f853 100644 --- a/src/apis/people/webpack.config.js +++ b/src/apis/people/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/playcustomapp/package.json b/src/apis/playcustomapp/package.json index 3f4ba2edb15..07d01dbaf92 100644 --- a/src/apis/playcustomapp/package.json +++ b/src/apis/playcustomapp/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/playcustomapp/webpack.config.js b/src/apis/playcustomapp/webpack.config.js index b92bc198b7b..70d01e492c3 100644 --- a/src/apis/playcustomapp/webpack.config.js +++ b/src/apis/playcustomapp/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/plus/package.json b/src/apis/plus/package.json index d3279bde2f7..322afd0adc1 100644 --- a/src/apis/plus/package.json +++ b/src/apis/plus/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/plus/webpack.config.js b/src/apis/plus/webpack.config.js index 89a565ab8a7..d074c1fea2e 100644 --- a/src/apis/plus/webpack.config.js +++ b/src/apis/plus/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/plusDomains/package.json b/src/apis/plusDomains/package.json index df82c69509f..46f299c84f9 100644 --- a/src/apis/plusDomains/package.json +++ b/src/apis/plusDomains/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/plusDomains/webpack.config.js b/src/apis/plusDomains/webpack.config.js index b9a15ce157b..cb8ba1c9fbd 100644 --- a/src/apis/plusDomains/webpack.config.js +++ b/src/apis/plusDomains/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/poly/package.json b/src/apis/poly/package.json index 0d01017ba10..efaf9abf3a3 100644 --- a/src/apis/poly/package.json +++ b/src/apis/poly/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/poly/webpack.config.js b/src/apis/poly/webpack.config.js index 917e4e338c1..f5ee9721284 100644 --- a/src/apis/poly/webpack.config.js +++ b/src/apis/poly/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/proximitybeacon/package.json b/src/apis/proximitybeacon/package.json index 282506068bb..355c9fcd11a 100644 --- a/src/apis/proximitybeacon/package.json +++ b/src/apis/proximitybeacon/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/proximitybeacon/webpack.config.js b/src/apis/proximitybeacon/webpack.config.js index 3c87cda4664..988acba2691 100644 --- a/src/apis/proximitybeacon/webpack.config.js +++ b/src/apis/proximitybeacon/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/pubsub/package.json b/src/apis/pubsub/package.json index 48f89bacee5..0ba44fc40fa 100644 --- a/src/apis/pubsub/package.json +++ b/src/apis/pubsub/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index 6690da33228..2ab6fbe29f5 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -255,6 +255,12 @@ export namespace pubsub_v1 { */ subscriptions?: string[]; } + export interface Schema$MessageStoragePolicy { + /** + * A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration. + */ + allowedPersistenceRegions?: string[]; + } /** * Request for the ModifyAckDeadline method. */ @@ -504,10 +510,18 @@ export namespace pubsub_v1 { * A topic resource. */ export interface Schema$Topic { + /** + * The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects/x/locations/x/keyRings/x/cryptoKeys/x. + */ + kmsKeyName?: string; /** * See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>. */ labels?: {[key: string]: string}; + /** + * Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect. + */ + messageStoragePolicy?: Schema$MessageStoragePolicy; /** * 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"`. */ @@ -575,6 +589,63 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.create * @desc Creates a snapshot from the requested subscription. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

If the snapshot already exists, returns `ALREADY_EXISTS`. If the requested subscription doesn't exist, returns `NOT_FOUND`. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned. See also the `Snapshot.expire_time` field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the [resource name format](https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Pub/Sub API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/pubsub + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var pubsub = google.pubsub('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Optional user-provided name for this snapshot. + * // If the name is not provided in the request, the server will assign a random + * // name for this snapshot on the same project as the subscription. + * // Note that for REST API requests, you must specify a name. See the + * // + * // resource name rules. + * // Format is `projects/{project}/snapshots/{snap}`. + * name: 'projects/my-project/snapshots/my-snapshot', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * pubsub.projects.snapshots.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias pubsub.projects.snapshots.create * @memberOf! () * @@ -645,6 +716,50 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.delete * @desc Removes an existing snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Pub/Sub API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/pubsub + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var pubsub = google.pubsub('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the snapshot to delete. + * // Format is `projects/{project}/snapshots/{snap}`. + * snapshot: 'projects/my-project/snapshots/my-snapshot', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * pubsub.projects.snapshots.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias pubsub.projects.snapshots.delete * @memberOf! () * @@ -714,6 +829,53 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.get * @desc Gets the configuration details of a snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Pub/Sub API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/pubsub + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var pubsub = google.pubsub('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the snapshot to get. + * // Format is `projects/{project}/snapshots/{snap}`. + * snapshot: 'projects/my-project/snapshots/my-snapshot', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * pubsub.projects.snapshots.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias pubsub.projects.snapshots.get * @memberOf! () * @@ -786,7 +948,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -798,7 +960,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -822,16 +984,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.snapshots.getIamPolicy @@ -906,6 +1064,66 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.list * @desc Lists the existing snapshots. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Pub/Sub API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/pubsub + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var pubsub = google.pubsub('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the project in which to list snapshots. + * // Format is `projects/{project-id}`. + * project: 'projects/my-project', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var snapshotsPage = response['snapshots']; + * if (!snapshotsPage) { + * return; + * } + * for (var i = 0; i < snapshotsPage.length; i++) { + * // TODO: Change code below to process each resource in `snapshotsPage`: + * console.log(JSON.stringify(snapshotsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * pubsub.projects.snapshots.list(request, handlePage); + * } + * }; + * + * pubsub.projects.snapshots.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias pubsub.projects.snapshots.list * @memberOf! () * @@ -984,6 +1202,57 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.patch * @desc Updates an existing snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Pub/Sub API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/pubsub + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var pubsub = google.pubsub('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the snapshot. + * name: 'projects/my-project/snapshots/my-snapshot', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * pubsub.projects.snapshots.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias pubsub.projects.snapshots.patch * @memberOf! () * @@ -1057,7 +1326,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -1069,7 +1338,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -1097,16 +1366,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.snapshots.setIamPolicy @@ -1185,7 +1450,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -1197,7 +1462,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -1225,16 +1490,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.snapshots.testIamPermissions @@ -1454,7 +1715,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -1466,7 +1727,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -1491,16 +1752,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.subscriptions.acknowledge @@ -1579,7 +1836,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -1591,7 +1848,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -1624,16 +1881,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.subscriptions.create @@ -1711,7 +1964,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -1723,7 +1976,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -1744,16 +1997,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.subscriptions.delete @@ -1831,7 +2080,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -1843,7 +2092,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -1867,16 +2116,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.subscriptions.get @@ -1956,7 +2201,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -1968,7 +2213,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -1992,16 +2237,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.subscriptions.getIamPolicy @@ -2079,7 +2320,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -2091,13 +2332,13 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { * var request = { - * // The name of the cloud project that subscriptions belong to. - * // Format is `projects/{project}`. + * // The name of the project in which to list subscriptions. + * // Format is `projects/{project-id}`. * project: 'projects/my-project', // TODO: Update placeholder value. * * auth: authClient, @@ -2128,16 +2369,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.subscriptions.list @@ -2226,7 +2463,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -2238,7 +2475,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -2263,16 +2500,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.subscriptions.modifyAckDeadline @@ -2351,7 +2584,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -2363,7 +2596,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -2388,16 +2621,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.subscriptions.modifyPushConfig @@ -2473,6 +2702,62 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.patch * @desc Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Pub/Sub API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/pubsub + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var pubsub = google.pubsub('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the subscription. It must have the format + * // `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` 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: 'projects/my-project/subscriptions/my-subscription', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * pubsub.projects.subscriptions.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias pubsub.projects.subscriptions.patch * @memberOf! () * @@ -2548,7 +2833,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -2560,7 +2845,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -2588,16 +2873,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.subscriptions.pull @@ -2675,6 +2956,56 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.seek * @desc Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Note that both the subscription and the snapshot must be on the same topic. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Pub/Sub API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/pubsub + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var pubsub = google.pubsub('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The subscription to affect. + * subscription: 'projects/my-project/subscriptions/my-subscription', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * pubsub.projects.subscriptions.seek(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias pubsub.projects.subscriptions.seek * @memberOf! () * @@ -2753,7 +3084,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -2765,7 +3096,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -2793,16 +3124,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.subscriptions.setIamPolicy @@ -2881,7 +3208,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -2893,7 +3220,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -2921,16 +3248,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.subscriptions.testIamPermissions @@ -3241,7 +3564,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -3253,7 +3576,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -3286,16 +3609,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.topics.create @@ -3371,7 +3690,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -3383,7 +3702,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -3404,16 +3723,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.topics.delete @@ -3488,7 +3803,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -3500,7 +3815,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -3524,16 +3839,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.topics.get @@ -3608,7 +3919,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -3620,7 +3931,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -3644,16 +3955,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.topics.getIamPolicy @@ -3731,7 +4038,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -3743,13 +4050,13 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { * var request = { - * // The name of the cloud project that topics belong to. - * // Format is `projects/{project}`. + * // The name of the project in which to list topics. + * // Format is `projects/{project-id}`. * project: 'projects/my-project', // TODO: Update placeholder value. * * auth: authClient, @@ -3780,16 +4087,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.topics.list @@ -3868,6 +4171,62 @@ export namespace pubsub_v1 { /** * pubsub.projects.topics.patch * @desc Updates an existing topic. Note that certain properties of a topic are not modifiable. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Pub/Sub API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/pubsub + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var pubsub = google.pubsub('v1'); + * + * authorize(function(authClient) { + * var request = { + * // 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: 'projects/my-project/topics/my-topic', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * pubsub.projects.topics.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias pubsub.projects.topics.patch * @memberOf! () * @@ -3941,7 +4300,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -3953,7 +4312,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -3981,16 +4340,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.topics.publish @@ -4071,7 +4426,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -4083,7 +4438,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -4111,16 +4466,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.topics.setIamPolicy @@ -4199,7 +4550,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -4211,7 +4562,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -4239,16 +4590,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.topics.testIamPermissions @@ -4482,6 +4829,66 @@ export namespace pubsub_v1 { /** * pubsub.projects.topics.snapshots.list * @desc Lists the names of the snapshots on this topic. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Pub/Sub API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/pubsub + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var pubsub = google.pubsub('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the topic that snapshots are attached to. + * // Format is `projects/{project}/topics/{topic}`. + * topic: 'projects/my-project/topics/my-topic', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var snapshotsPage = response['snapshots']; + * if (!snapshotsPage) { + * return; + * } + * for (var i = 0; i < snapshotsPage.length; i++) { + * // TODO: Change code below to process each resource in `snapshotsPage`: + * console.log(JSON.stringify(snapshotsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * pubsub.projects.topics.snapshots.list(request, handlePage); + * } + * }; + * + * pubsub.projects.topics.snapshots.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias pubsub.projects.topics.snapshots.list * @memberOf! () * @@ -4596,7 +5003,7 @@ export namespace pubsub_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Pub/Sub API + * // 1. If not already done, enable the Cloud Pub/Sub API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/pubsub * // 2. This sample uses Application Default Credentials for authentication. @@ -4608,7 +5015,7 @@ export namespace pubsub_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var pubsub = google.pubsub('v1'); * * authorize(function(authClient) { @@ -4645,16 +5052,12 @@ export namespace pubsub_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias pubsub.projects.topics.subscriptions.list diff --git a/src/apis/pubsub/webpack.config.js b/src/apis/pubsub/webpack.config.js index c8dedc31227..18b8fb713e3 100644 --- a/src/apis/pubsub/webpack.config.js +++ b/src/apis/pubsub/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/redis/package.json b/src/apis/redis/package.json index 78ea191189f..931b71a0341 100644 --- a/src/apis/redis/package.json +++ b/src/apis/redis/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/redis/v1.ts b/src/apis/redis/v1.ts index 7ff7e53cf69..f31674f44cd 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -121,6 +121,15 @@ export namespace redis_v1 { * 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 {} + /** + * Request for Export. + */ + export interface Schema$ExportInstanceRequest { + /** + * Required. Specify data to be exported. + */ + outputConfig?: Schema$OutputConfig; + } /** * Request for Failover. */ @@ -130,6 +139,24 @@ export namespace redis_v1 { */ dataProtectionMode?: string; } + /** + * The Cloud Storage location for the output content + */ + export interface Schema$GcsDestination { + /** + * Required. Data destination URI (e.g. 'gs://my_bucket/my_object'). Existing files will be overwritten. + */ + uri?: string; + } + /** + * The Cloud Storage location for the input content + */ + export interface Schema$GcsSource { + /** + * Required. Source data URI. (e.g. 'gs://my_bucket/my_object'). + */ + uri?: 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. */ @@ -176,6 +203,24 @@ export namespace redis_v1 { * Defines specific information for a particular zone. Currently empty and reserved for future use only. */ export interface Schema$GoogleCloudRedisV1ZoneMetadata {} + /** + * Request for Import. + */ + export interface Schema$ImportInstanceRequest { + /** + * Required. Specify data to be imported. + */ + inputConfig?: Schema$InputConfig; + } + /** + * The input content + */ + export interface Schema$InputConfig { + /** + * Google Cloud Storage location where input content is located. + */ + gcsSource?: Schema$GcsSource; + } /** * A Google Cloud Redis instance. */ @@ -220,16 +265,20 @@ export namespace redis_v1 { * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details. */ name?: string; + /** + * Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:<service_account_email>". The value may change over time for a given instance so should be checked before each import/export operation. + */ + persistenceIamIdentity?: string; /** * Output only. The port number of the exposed Redis endpoint. */ port?: number; /** - * Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: * maxmemory-policy * notify-keyspace-events + * Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis 3.2 and above: * maxmemory-policy * notify-keyspace-events Redis 4.0 and above: * activedefrag * lfu-log-factor * lfu-decay-time */ redisConfigs?: {[key: string]: string}; /** - * Optional. The version of Redis software. If not provided, latest supported version will be used. Updating the version will perform an upgrade/downgrade to the new version. Currently, the supported values are `REDIS_3_2` for Redis 3.2. + * Optional. The version of Redis software. If not provided, latest supported version will be used. Updating the version will perform an upgrade/downgrade to the new version. Currently, the supported values are: * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_3_2` for Redis 3.2 compatibility */ redisVersion?: string; /** @@ -334,7 +383,7 @@ export namespace redis_v1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -343,7 +392,16 @@ export namespace redis_v1 { response?: {[key: string]: 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. + * The output content + */ + export interface Schema$OutputConfig { + /** + * Google Cloud Storage destination for output content. + */ + gcsDestination?: Schema$GcsDestination; + } + /** + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -720,6 +778,78 @@ export namespace redis_v1 { } } + /** + * redis.projects.locations.instances.export + * @desc Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. + * @alias redis.projects.locations.instances.export + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. + * @param {().ExportInstanceRequest} 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 + */ + export( + params?: Params$Resource$Projects$Locations$Instances$Export, + options?: MethodOptions + ): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Instances$Export, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Instances$Export, + callback: BodyResponseCallback + ): void; + export(callback: BodyResponseCallback): void; + export( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Export + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Export; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Export; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://redis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:export').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * redis.projects.locations.instances.failover * @desc Initiates a failover of the master node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance. @@ -864,6 +994,78 @@ export namespace redis_v1 { } } + /** + * redis.projects.locations.instances.import + * @desc Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. + * @alias redis.projects.locations.instances.import + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. + * @param {().ImportInstanceRequest} 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 + */ + import( + params?: Params$Resource$Projects$Locations$Instances$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Instances$Import, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Instances$Import, + callback: BodyResponseCallback + ): void; + import(callback: BodyResponseCallback): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Import + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://redis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:import').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * redis.projects.locations.instances.list * @desc Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated. @@ -1049,6 +1251,23 @@ export namespace redis_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Instances$Export + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExportInstanceRequest; + } export interface Params$Resource$Projects$Locations$Instances$Failover extends StandardParameters { /** @@ -1078,6 +1297,23 @@ export namespace redis_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Instances$Import + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ImportInstanceRequest; + } export interface Params$Resource$Projects$Locations$Instances$List extends StandardParameters { /** diff --git a/src/apis/redis/v1beta1.ts b/src/apis/redis/v1beta1.ts index 467f2366d56..80aaa5ee2cb 100644 --- a/src/apis/redis/v1beta1.ts +++ b/src/apis/redis/v1beta1.ts @@ -121,6 +121,42 @@ export namespace redis_v1beta1 { * 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 {} + /** + * Request for Export. + */ + export interface Schema$ExportInstanceRequest { + /** + * Required. Specify data to be exported. + */ + outputConfig?: Schema$OutputConfig; + } + /** + * Request for Failover. + */ + export interface Schema$FailoverInstanceRequest { + /** + * Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default. + */ + dataProtectionMode?: string; + } + /** + * The Cloud Storage location for the output content + */ + export interface Schema$GcsDestination { + /** + * Required. Data destination URI (e.g. 'gs://my_bucket/my_object'). Existing files will be overwritten. + */ + uri?: string; + } + /** + * The Cloud Storage location for the input content + */ + export interface Schema$GcsSource { + /** + * Required. Source data URI. (e.g. 'gs://my_bucket/my_object'). + */ + uri?: string; + } /** * Represents the metadata of the long-running operation. */ @@ -169,6 +205,24 @@ export namespace redis_v1beta1 { * Defines specific information for a particular zone. Currently empty and reserved for future use only. */ export interface Schema$GoogleCloudRedisV1beta1ZoneMetadata {} + /** + * Request for Import. + */ + export interface Schema$ImportInstanceRequest { + /** + * Required. Specify data to be imported. + */ + inputConfig?: Schema$InputConfig; + } + /** + * The input content + */ + export interface Schema$InputConfig { + /** + * Google Cloud Storage location where input content is located. + */ + gcsSource?: Schema$GcsSource; + } /** * A Google Cloud Redis instance. */ @@ -213,6 +267,10 @@ export namespace redis_v1beta1 { * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details. */ name?: string; + /** + * Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:<service_account_email>". The value may change over time for a given instance so should be checked before each import/export operation. + */ + persistenceIamIdentity?: string; /** * Output only. The port number of the exposed Redis endpoint. */ @@ -222,7 +280,7 @@ export namespace redis_v1beta1 { */ redisConfigs?: {[key: string]: string}; /** - * Optional. The version of Redis software. If not provided, latest supported version will be used. Updating the version will perform an upgrade/downgrade to the new version. Currently, the supported values are: * `REDIS_4_0` for Redis 4.0 compatibility * `REDIS_3_2` for Redis 3.2 compatibility (default) + * Optional. The version of Redis software. If not provided, latest supported version will be used. Updating the version will perform an upgrade/downgrade to the new version. Currently, the supported values are: * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_3_2` for Redis 3.2 compatibility */ redisVersion?: string; /** @@ -327,7 +385,7 @@ export namespace redis_v1beta1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -336,7 +394,16 @@ export namespace redis_v1beta1 { response?: {[key: string]: 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. + * The output content + */ + export interface Schema$OutputConfig { + /** + * Google Cloud Storage destination for output content. + */ + gcsDestination?: Schema$GcsDestination; + } + /** + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -713,6 +780,156 @@ export namespace redis_v1beta1 { } } + /** + * redis.projects.locations.instances.export + * @desc Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. + * @alias redis.projects.locations.instances.export + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. + * @param {().ExportInstanceRequest} 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 + */ + export( + params?: Params$Resource$Projects$Locations$Instances$Export, + options?: MethodOptions + ): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Instances$Export, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Instances$Export, + callback: BodyResponseCallback + ): void; + export(callback: BodyResponseCallback): void; + export( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Export + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Export; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Export; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://redis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:export').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * redis.projects.locations.instances.failover + * @desc Initiates a failover of the master node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance. + * @alias redis.projects.locations.instances.failover + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. + * @param {().FailoverInstanceRequest} 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 + */ + failover( + params?: Params$Resource$Projects$Locations$Instances$Failover, + options?: MethodOptions + ): GaxiosPromise; + failover( + params: Params$Resource$Projects$Locations$Instances$Failover, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + failover( + params: Params$Resource$Projects$Locations$Instances$Failover, + callback: BodyResponseCallback + ): void; + failover(callback: BodyResponseCallback): void; + failover( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Failover + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Failover; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Failover; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://redis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:failover').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * redis.projects.locations.instances.get * @desc Gets the details of a specific Redis instance. @@ -782,6 +999,81 @@ export namespace redis_v1beta1 { } } + /** + * redis.projects.locations.instances.import + * @desc Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. + * @alias redis.projects.locations.instances.import + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. + * @param {().ImportInstanceRequest} 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 + */ + import( + params?: Params$Resource$Projects$Locations$Instances$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Instances$Import, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Instances$Import, + callback: BodyResponseCallback + ): void; + import(callback: BodyResponseCallback): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Import + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://redis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * redis.projects.locations.instances.list * @desc Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated. @@ -967,6 +1259,40 @@ export namespace redis_v1beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Instances$Export + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExportInstanceRequest; + } + export interface Params$Resource$Projects$Locations$Instances$Failover + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FailoverInstanceRequest; + } export interface Params$Resource$Projects$Locations$Instances$Get extends StandardParameters { /** @@ -979,6 +1305,23 @@ export namespace redis_v1beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Instances$Import + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ImportInstanceRequest; + } export interface Params$Resource$Projects$Locations$Instances$List extends StandardParameters { /** diff --git a/src/apis/redis/webpack.config.js b/src/apis/redis/webpack.config.js index 48f3d6af226..68df4ac588f 100644 --- a/src/apis/redis/webpack.config.js +++ b/src/apis/redis/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/remotebuildexecution/package.json b/src/apis/remotebuildexecution/package.json index 977b570ade3..17f6b1102fb 100644 --- a/src/apis/remotebuildexecution/package.json +++ b/src/apis/remotebuildexecution/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/remotebuildexecution/v1.ts b/src/apis/remotebuildexecution/v1.ts index c3f9db12efc..b845ca929da 100644 --- a/src/apis/remotebuildexecution/v1.ts +++ b/src/apis/remotebuildexecution/v1.ts @@ -132,7 +132,7 @@ export namespace remotebuildexecution_v1 { */ commandDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * If true, then the `Action`'s result cannot be cached. + * If true, then the `Action`'s result cannot be cached, and in-flight requests for the same `Action` may not be merged. */ doNotCache?: boolean; /** @@ -157,35 +157,35 @@ export namespace remotebuildexecution_v1 { */ exitCode?: number; /** - * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` + * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` If an output of the same name was found, but was not a directory, the server will return a FAILED_PRECONDITION. */ outputDirectories?: Schema$BuildBazelRemoteExecutionV2OutputDirectory[]; /** - * The output directories of the action that are symbolic links to other directories. Those may be links to other output directories, or input directories, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output directory requested in the `output_directories` field of the Action, if the directory file existed after the action completed, a single entry will be present either in this field, or in the `output_directories` field, if the directory was not a symbolic link. If the action does not produce the requested output, or produces a file where a directory is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. + * The output directories of the action that are symbolic links to other directories. Those may be links to other output directories, or input directories, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output directory requested in the `output_directories` field of the Action, if the directory existed after the action completed, a single entry will be present either in this field, or in the `output_directories` field, if the directory was not a symbolic link. If an output of the same name was found, but was a symbolic link to a file instead of a directory, the server will return a FAILED_PRECONDITION. If the action does not produce the requested output, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputDirectorySymlinks?: Schema$BuildBazelRemoteExecutionV2OutputSymlink[]; /** - * The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the output_file_symlinks field, if the file was a symbolic link to another file. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. + * The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or the `output_file_symlinks` field if the file was a symbolic link to another file. If an output of the same name was found, but was a directory rather than a regular file, the server will return a FAILED_PRECONDITION. If the action does not produce the requested output, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputFiles?: Schema$BuildBazelRemoteExecutionV2OutputFile[]; /** - * The output files of the action that are symbolic links to other files. Those may be links to other output files, or input files, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the `output_files` field, if the file was not a symbolic link. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. + * The output files of the action that are symbolic links to other files. Those may be links to other output files, or input files, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the `output_files` field, if the file was not a symbolic link. If an output symbolic link of the same name was found, but its target type was not a regular file, the server will return a FAILED_PRECONDITION. If the action does not produce the requested output, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputFileSymlinks?: Schema$BuildBazelRemoteExecutionV2OutputSymlink[]; /** - * The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage. See `stderr_raw` for when this will be set. + * The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage. */ stderrDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stderr_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. + * The standard error buffer of the action. The server SHOULD NOT inline stderr unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. */ stderrRaw?: string; /** - * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. See `stdout_raw` for when this will be set. + * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. */ stdoutDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stdout_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. + * The standard output buffer of the action. The server SHOULD NOT inline stdout unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. */ stdoutRaw?: string; } @@ -202,7 +202,7 @@ export namespace remotebuildexecution_v1 { */ environmentVariables?: Schema$BuildBazelRemoteExecutionV2CommandEnvironmentVariable[]; /** - * A list of the output directories that the client expects to retrieve from the action. Only the listed directories will be returned (an entire directory structure will be returned as a Tree message digest, see OutputDirectory), as well as files listed in `output_files`. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. The special value of empty string is allowed, although not recommended, and can be used to capture the entire working directory tree, including inputs. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output directory cannot be duplicated or have the same path as any of the listed output files. Directories leading up to the output directories (but not the output directories themselves) are created by the worker prior to execution, even if they are not explicitly part of the input root. + * A list of the output directories that the client expects to retrieve from the action. Only the listed directories will be returned (an entire directory structure will be returned as a Tree message digest, see OutputDirectory), as well as files listed in `output_files`. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. The special value of empty string is allowed, although not recommended, and can be used to capture the entire working directory tree, including inputs. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output directory cannot be duplicated or have the same path as any of the listed output files. An output directory is allowed to be a parent of another output directory. Directories leading up to the output directories (but not the output directories themselves) are created by the worker prior to execution, even if they are not explicitly part of the input root. */ outputDirectories?: string[]; /** @@ -210,7 +210,7 @@ export namespace remotebuildexecution_v1 { */ outputFiles?: string[]; /** - * The platform requirements for the execution environment. The server MAY choose to execute the action on any worker satisfying the requirements, so the client SHOULD ensure that running the action on any such worker will have the same result. + * The platform requirements for the execution environment. The server MAY choose to execute the action on any worker satisfying the requirements, so the client SHOULD ensure that running the action on any such worker will have the same result. A detailed lexicon for this can be found in the accompanying platform.md. */ platform?: Schema$BuildBazelRemoteExecutionV2Platform; /** @@ -245,7 +245,7 @@ export namespace remotebuildexecution_v1 { sizeBytes?: string; } /** - * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains its name in the directory, either the digest of its content (either a file blob or a `Directory` proto) or a symlink target, as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: * Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. * Each child in the directory must have a unique path segment (file name). * The files, directories and symlinks in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` + * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains its name in the directory, either the digest of its content (either a file blob or a `Directory` proto) or a symlink target, as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: * Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. * Each child in the directory must have a unique path segment (file name). Note that while the API itself is case-sensitive, the environment where the Action is executed may or may not be case-sensitive. That is, it is legal to call the API with a Directory that has both "Foo" and "foo" as children, but the Action may be rejected by the remote system upon execution. * The files, directories and symlinks in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` */ export interface Schema$BuildBazelRemoteExecutionV2Directory { /** @@ -327,6 +327,9 @@ export namespace remotebuildexecution_v1 { * The digest of the Action being executed. */ actionDigest?: Schema$BuildBazelRemoteExecutionV2Digest; + /** + * The current stage of execution. + */ stage?: string; /** * If set, the client can use this name with ByteStream.Read to stream the standard error. @@ -406,9 +409,13 @@ export namespace remotebuildexecution_v1 { treeDigest?: Schema$BuildBazelRemoteExecutionV2Digest; } /** - * An `OutputFile` is similar to a FileNode, but it is used as an output in an `ActionResult`. It allows a full file path rather than only a name. `OutputFile` is binary-compatible with `FileNode`. + * An `OutputFile` is similar to a FileNode, but it is used as an output in an `ActionResult`. It allows a full file path rather than only a name. */ export interface Schema$BuildBazelRemoteExecutionV2OutputFile { + /** + * The contents of the file if inlining was requested. The server SHOULD NOT inline file contents unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. + */ + contents?: string; /** * The digest of the file's content. */ @@ -458,7 +465,7 @@ export namespace remotebuildexecution_v1 { value?: string; } /** - * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: * name: `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` message. + * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: * name: `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` message. Note: the gRPC library serializes binary headers encoded in base 64 by default (https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests). Therefore, if the gRPC library is used to pass/retrieve this metadata, the user may ignore the base64 encoding and assume it is simply serialized as a binary message. */ export interface Schema$BuildBazelRemoteExecutionV2RequestMetadata { /** @@ -580,6 +587,19 @@ export namespace remotebuildexecution_v1 { */ numWarnings?: string; } + /** + * The internal status of the command result. + */ + export interface Schema$GoogleDevtoolsRemotebuildbotCommandStatus { + /** + * The status code. + */ + code?: string; + /** + * The error message. + */ + message?: string; + } /** * The request used for `CreateInstance`. */ @@ -684,6 +704,10 @@ export namespace remotebuildexecution_v1 { instances?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance[]; } export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest { + /** + * Optional. A filter to constrain the pools returned. Filters have the form: <field> <operator> <value> [[AND|OR] <field> <operator> <value>]... <field> is the path for a field or map key in the Pool proto message. e.g. "configuration.disk_size_gb" or "configuration.labels.key". <operator> can be one of "<", "<=", ">=", ">", "=", "!=", ":". ":" is a HAS operation for strings and repeated primitive fields. <value> is the value to test, case-insensitive for strings. "*" stands for any value and can be used to test for key presence. Parenthesis determine AND/OR precedence. In space separated restrictions, AND is implicit, e.g. "a = b x = y" is equivalent to "a = b AND x = y". Example filter: configuration.labels.key1 = * AND (state = RUNNING OR state = UPDATING) + */ + filter?: string; /** * Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ @@ -720,6 +744,10 @@ export namespace remotebuildexecution_v1 { * Required. Disk Type to use for the worker. See [Storage options](https://cloud.google.com/compute/docs/disks/#introduction). Currently only `pd-standard` is supported. */ diskType?: string; + /** + * Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Keys must start with a letter but values are optional. There can not be more than 64 labels per resource. + */ + labels?: {[key: string]: string}; /** * Required. Machine type of the worker, such as `n1-standard-2`. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that `f1-micro` and `g1-small` are not yet supported. */ @@ -1289,7 +1317,7 @@ export namespace remotebuildexecution_v1 { */ export interface Schema$GoogleProtobufEmpty {} /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$GoogleRpcStatus { /** diff --git a/src/apis/remotebuildexecution/v1alpha.ts b/src/apis/remotebuildexecution/v1alpha.ts index 9ea17e60c3b..525c4f2f047 100644 --- a/src/apis/remotebuildexecution/v1alpha.ts +++ b/src/apis/remotebuildexecution/v1alpha.ts @@ -126,7 +126,7 @@ export namespace remotebuildexecution_v1alpha { */ commandDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * If true, then the `Action`'s result cannot be cached. + * If true, then the `Action`'s result cannot be cached, and in-flight requests for the same `Action` may not be merged. */ doNotCache?: boolean; /** @@ -151,35 +151,35 @@ export namespace remotebuildexecution_v1alpha { */ exitCode?: number; /** - * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` + * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` If an output of the same name was found, but was not a directory, the server will return a FAILED_PRECONDITION. */ outputDirectories?: Schema$BuildBazelRemoteExecutionV2OutputDirectory[]; /** - * The output directories of the action that are symbolic links to other directories. Those may be links to other output directories, or input directories, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output directory requested in the `output_directories` field of the Action, if the directory file existed after the action completed, a single entry will be present either in this field, or in the `output_directories` field, if the directory was not a symbolic link. If the action does not produce the requested output, or produces a file where a directory is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. + * The output directories of the action that are symbolic links to other directories. Those may be links to other output directories, or input directories, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output directory requested in the `output_directories` field of the Action, if the directory existed after the action completed, a single entry will be present either in this field, or in the `output_directories` field, if the directory was not a symbolic link. If an output of the same name was found, but was a symbolic link to a file instead of a directory, the server will return a FAILED_PRECONDITION. If the action does not produce the requested output, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputDirectorySymlinks?: Schema$BuildBazelRemoteExecutionV2OutputSymlink[]; /** - * The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the output_file_symlinks field, if the file was a symbolic link to another file. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. + * The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or the `output_file_symlinks` field if the file was a symbolic link to another file. If an output of the same name was found, but was a directory rather than a regular file, the server will return a FAILED_PRECONDITION. If the action does not produce the requested output, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputFiles?: Schema$BuildBazelRemoteExecutionV2OutputFile[]; /** - * The output files of the action that are symbolic links to other files. Those may be links to other output files, or input files, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the `output_files` field, if the file was not a symbolic link. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. + * The output files of the action that are symbolic links to other files. Those may be links to other output files, or input files, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the `output_files` field, if the file was not a symbolic link. If an output symbolic link of the same name was found, but its target type was not a regular file, the server will return a FAILED_PRECONDITION. If the action does not produce the requested output, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputFileSymlinks?: Schema$BuildBazelRemoteExecutionV2OutputSymlink[]; /** - * The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage. See `stderr_raw` for when this will be set. + * The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage. */ stderrDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stderr_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. + * The standard error buffer of the action. The server SHOULD NOT inline stderr unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. */ stderrRaw?: string; /** - * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. See `stdout_raw` for when this will be set. + * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. */ stdoutDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stdout_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. + * The standard output buffer of the action. The server SHOULD NOT inline stdout unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. */ stdoutRaw?: string; } @@ -196,7 +196,7 @@ export namespace remotebuildexecution_v1alpha { */ environmentVariables?: Schema$BuildBazelRemoteExecutionV2CommandEnvironmentVariable[]; /** - * A list of the output directories that the client expects to retrieve from the action. Only the listed directories will be returned (an entire directory structure will be returned as a Tree message digest, see OutputDirectory), as well as files listed in `output_files`. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. The special value of empty string is allowed, although not recommended, and can be used to capture the entire working directory tree, including inputs. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output directory cannot be duplicated or have the same path as any of the listed output files. Directories leading up to the output directories (but not the output directories themselves) are created by the worker prior to execution, even if they are not explicitly part of the input root. + * A list of the output directories that the client expects to retrieve from the action. Only the listed directories will be returned (an entire directory structure will be returned as a Tree message digest, see OutputDirectory), as well as files listed in `output_files`. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. The special value of empty string is allowed, although not recommended, and can be used to capture the entire working directory tree, including inputs. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output directory cannot be duplicated or have the same path as any of the listed output files. An output directory is allowed to be a parent of another output directory. Directories leading up to the output directories (but not the output directories themselves) are created by the worker prior to execution, even if they are not explicitly part of the input root. */ outputDirectories?: string[]; /** @@ -204,7 +204,7 @@ export namespace remotebuildexecution_v1alpha { */ outputFiles?: string[]; /** - * The platform requirements for the execution environment. The server MAY choose to execute the action on any worker satisfying the requirements, so the client SHOULD ensure that running the action on any such worker will have the same result. + * The platform requirements for the execution environment. The server MAY choose to execute the action on any worker satisfying the requirements, so the client SHOULD ensure that running the action on any such worker will have the same result. A detailed lexicon for this can be found in the accompanying platform.md. */ platform?: Schema$BuildBazelRemoteExecutionV2Platform; /** @@ -239,7 +239,7 @@ export namespace remotebuildexecution_v1alpha { sizeBytes?: string; } /** - * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains its name in the directory, either the digest of its content (either a file blob or a `Directory` proto) or a symlink target, as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: * Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. * Each child in the directory must have a unique path segment (file name). * The files, directories and symlinks in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` + * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains its name in the directory, either the digest of its content (either a file blob or a `Directory` proto) or a symlink target, as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: * Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. * Each child in the directory must have a unique path segment (file name). Note that while the API itself is case-sensitive, the environment where the Action is executed may or may not be case-sensitive. That is, it is legal to call the API with a Directory that has both "Foo" and "foo" as children, but the Action may be rejected by the remote system upon execution. * The files, directories and symlinks in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` */ export interface Schema$BuildBazelRemoteExecutionV2Directory { /** @@ -321,6 +321,9 @@ export namespace remotebuildexecution_v1alpha { * The digest of the Action being executed. */ actionDigest?: Schema$BuildBazelRemoteExecutionV2Digest; + /** + * The current stage of execution. + */ stage?: string; /** * If set, the client can use this name with ByteStream.Read to stream the standard error. @@ -400,9 +403,13 @@ export namespace remotebuildexecution_v1alpha { treeDigest?: Schema$BuildBazelRemoteExecutionV2Digest; } /** - * An `OutputFile` is similar to a FileNode, but it is used as an output in an `ActionResult`. It allows a full file path rather than only a name. `OutputFile` is binary-compatible with `FileNode`. + * An `OutputFile` is similar to a FileNode, but it is used as an output in an `ActionResult`. It allows a full file path rather than only a name. */ export interface Schema$BuildBazelRemoteExecutionV2OutputFile { + /** + * The contents of the file if inlining was requested. The server SHOULD NOT inline file contents unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. + */ + contents?: string; /** * The digest of the file's content. */ @@ -452,7 +459,7 @@ export namespace remotebuildexecution_v1alpha { value?: string; } /** - * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: * name: `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` message. + * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: * name: `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` message. Note: the gRPC library serializes binary headers encoded in base 64 by default (https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests). Therefore, if the gRPC library is used to pass/retrieve this metadata, the user may ignore the base64 encoding and assume it is simply serialized as a binary message. */ export interface Schema$BuildBazelRemoteExecutionV2RequestMetadata { /** @@ -565,6 +572,19 @@ export namespace remotebuildexecution_v1alpha { */ numWarnings?: string; } + /** + * The internal status of the command result. + */ + export interface Schema$GoogleDevtoolsRemotebuildbotCommandStatus { + /** + * The status code. + */ + code?: string; + /** + * The error message. + */ + message?: string; + } /** * The request used for `CreateInstance`. */ @@ -669,6 +689,10 @@ export namespace remotebuildexecution_v1alpha { instances?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance[]; } export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest { + /** + * Optional. A filter to constrain the pools returned. Filters have the form: <field> <operator> <value> [[AND|OR] <field> <operator> <value>]... <field> is the path for a field or map key in the Pool proto message. e.g. "configuration.disk_size_gb" or "configuration.labels.key". <operator> can be one of "<", "<=", ">=", ">", "=", "!=", ":". ":" is a HAS operation for strings and repeated primitive fields. <value> is the value to test, case-insensitive for strings. "*" stands for any value and can be used to test for key presence. Parenthesis determine AND/OR precedence. In space separated restrictions, AND is implicit, e.g. "a = b x = y" is equivalent to "a = b AND x = y". Example filter: configuration.labels.key1 = * AND (state = RUNNING OR state = UPDATING) + */ + filter?: string; /** * Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ @@ -705,6 +729,10 @@ export namespace remotebuildexecution_v1alpha { * Required. Disk Type to use for the worker. See [Storage options](https://cloud.google.com/compute/docs/disks/#introduction). Currently only `pd-standard` is supported. */ diskType?: string; + /** + * Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Keys must start with a letter but values are optional. There can not be more than 64 labels per resource. + */ + labels?: {[key: string]: string}; /** * Required. Machine type of the worker, such as `n1-standard-2`. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that `f1-micro` and `g1-small` are not yet supported. */ @@ -1253,7 +1281,7 @@ export namespace remotebuildexecution_v1alpha { response?: {[key: string]: 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$GoogleRpcStatus { /** @@ -1980,6 +2008,7 @@ export namespace remotebuildexecution_v1alpha { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.filter Optional. A filter to constrain the pools returned. Filters have the form: [[AND|OR] ]... is the path for a field or map key in the Pool proto message. e.g. "configuration.disk_size_gb" or "configuration.labels.key". can be one of "<", "<=", ">=", ">", "=", "!=", ":". ":" is a HAS operation for strings and repeated primitive fields. is the value to test, case-insensitive for strings. "*" stands for any value and can be used to test for key presence. Parenthesis determine AND/OR precedence. In space separated restrictions, AND is implicit, e.g. "a = b x = y" is equivalent to "a = b AND x = y". Example filter: configuration.labels.key1 = * AND (state = RUNNING OR state = UPDATING) * @param {string} params.parent Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2203,6 +2232,10 @@ export namespace remotebuildexecution_v1alpha { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. A filter to constrain the pools returned. Filters have the form: [[AND|OR] ]... is the path for a field or map key in the Pool proto message. e.g. "configuration.disk_size_gb" or "configuration.labels.key". can be one of "<", "<=", ">=", ">", "=", "!=", ":". ":" is a HAS operation for strings and repeated primitive fields. is the value to test, case-insensitive for strings. "*" stands for any value and can be used to test for key presence. Parenthesis determine AND/OR precedence. In space separated restrictions, AND is implicit, e.g. "a = b x = y" is equivalent to "a = b AND x = y". Example filter: configuration.labels.key1 = * AND (state = RUNNING OR state = UPDATING) + */ + filter?: string; /** * Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ diff --git a/src/apis/remotebuildexecution/v2.ts b/src/apis/remotebuildexecution/v2.ts index 8fc9172d361..d67e2320136 100644 --- a/src/apis/remotebuildexecution/v2.ts +++ b/src/apis/remotebuildexecution/v2.ts @@ -134,7 +134,7 @@ export namespace remotebuildexecution_v2 { */ commandDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * If true, then the `Action`'s result cannot be cached. + * If true, then the `Action`'s result cannot be cached, and in-flight requests for the same `Action` may not be merged. */ doNotCache?: boolean; /** @@ -165,35 +165,35 @@ export namespace remotebuildexecution_v2 { */ exitCode?: number; /** - * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` + * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` If an output of the same name was found, but was not a directory, the server will return a FAILED_PRECONDITION. */ outputDirectories?: Schema$BuildBazelRemoteExecutionV2OutputDirectory[]; /** - * The output directories of the action that are symbolic links to other directories. Those may be links to other output directories, or input directories, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output directory requested in the `output_directories` field of the Action, if the directory file existed after the action completed, a single entry will be present either in this field, or in the `output_directories` field, if the directory was not a symbolic link. If the action does not produce the requested output, or produces a file where a directory is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. + * The output directories of the action that are symbolic links to other directories. Those may be links to other output directories, or input directories, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output directory requested in the `output_directories` field of the Action, if the directory existed after the action completed, a single entry will be present either in this field, or in the `output_directories` field, if the directory was not a symbolic link. If an output of the same name was found, but was a symbolic link to a file instead of a directory, the server will return a FAILED_PRECONDITION. If the action does not produce the requested output, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputDirectorySymlinks?: Schema$BuildBazelRemoteExecutionV2OutputSymlink[]; /** - * The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the output_file_symlinks field, if the file was a symbolic link to another file. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. + * The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or the `output_file_symlinks` field if the file was a symbolic link to another file. If an output of the same name was found, but was a directory rather than a regular file, the server will return a FAILED_PRECONDITION. If the action does not produce the requested output, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputFiles?: Schema$BuildBazelRemoteExecutionV2OutputFile[]; /** - * The output files of the action that are symbolic links to other files. Those may be links to other output files, or input files, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the `output_files` field, if the file was not a symbolic link. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. + * The output files of the action that are symbolic links to other files. Those may be links to other output files, or input files, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the `output_files` field, if the file was not a symbolic link. If an output symbolic link of the same name was found, but its target type was not a regular file, the server will return a FAILED_PRECONDITION. If the action does not produce the requested output, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. */ outputFileSymlinks?: Schema$BuildBazelRemoteExecutionV2OutputSymlink[]; /** - * The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage. See `stderr_raw` for when this will be set. + * The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage. */ stderrDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stderr_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. + * The standard error buffer of the action. The server SHOULD NOT inline stderr unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. */ stderrRaw?: string; /** - * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. See `stdout_raw` for when this will be set. + * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. */ stdoutDigest?: Schema$BuildBazelRemoteExecutionV2Digest; /** - * The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stdout_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. + * The standard output buffer of the action. The server SHOULD NOT inline stdout unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. */ stdoutRaw?: string; } @@ -216,7 +216,7 @@ export namespace remotebuildexecution_v2 { responses?: Schema$BuildBazelRemoteExecutionV2BatchReadBlobsResponseResponse[]; } /** - * A response corresponding to a single blob that the client tried to upload. + * A response corresponding to a single blob that the client tried to download. */ export interface Schema$BuildBazelRemoteExecutionV2BatchReadBlobsResponseResponse { /** @@ -314,7 +314,7 @@ export namespace remotebuildexecution_v2 { */ environmentVariables?: Schema$BuildBazelRemoteExecutionV2CommandEnvironmentVariable[]; /** - * A list of the output directories that the client expects to retrieve from the action. Only the listed directories will be returned (an entire directory structure will be returned as a Tree message digest, see OutputDirectory), as well as files listed in `output_files`. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. The special value of empty string is allowed, although not recommended, and can be used to capture the entire working directory tree, including inputs. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output directory cannot be duplicated or have the same path as any of the listed output files. Directories leading up to the output directories (but not the output directories themselves) are created by the worker prior to execution, even if they are not explicitly part of the input root. + * A list of the output directories that the client expects to retrieve from the action. Only the listed directories will be returned (an entire directory structure will be returned as a Tree message digest, see OutputDirectory), as well as files listed in `output_files`. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. The special value of empty string is allowed, although not recommended, and can be used to capture the entire working directory tree, including inputs. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output directory cannot be duplicated or have the same path as any of the listed output files. An output directory is allowed to be a parent of another output directory. Directories leading up to the output directories (but not the output directories themselves) are created by the worker prior to execution, even if they are not explicitly part of the input root. */ outputDirectories?: string[]; /** @@ -322,7 +322,7 @@ export namespace remotebuildexecution_v2 { */ outputFiles?: string[]; /** - * The platform requirements for the execution environment. The server MAY choose to execute the action on any worker satisfying the requirements, so the client SHOULD ensure that running the action on any such worker will have the same result. + * The platform requirements for the execution environment. The server MAY choose to execute the action on any worker satisfying the requirements, so the client SHOULD ensure that running the action on any such worker will have the same result. A detailed lexicon for this can be found in the accompanying platform.md. */ platform?: Schema$BuildBazelRemoteExecutionV2Platform; /** @@ -357,7 +357,7 @@ export namespace remotebuildexecution_v2 { sizeBytes?: string; } /** - * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains its name in the directory, either the digest of its content (either a file blob or a `Directory` proto) or a symlink target, as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: * Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. * Each child in the directory must have a unique path segment (file name). * The files, directories and symlinks in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` + * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains its name in the directory, either the digest of its content (either a file blob or a `Directory` proto) or a symlink target, as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: * Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. * Each child in the directory must have a unique path segment (file name). Note that while the API itself is case-sensitive, the environment where the Action is executed may or may not be case-sensitive. That is, it is legal to call the API with a Directory that has both "Foo" and "foo" as children, but the Action may be rejected by the remote system upon execution. * The files, directories and symlinks in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` */ export interface Schema$BuildBazelRemoteExecutionV2Directory { /** @@ -439,6 +439,9 @@ export namespace remotebuildexecution_v2 { * The digest of the Action being executed. */ actionDigest?: Schema$BuildBazelRemoteExecutionV2Digest; + /** + * The current stage of execution. + */ stage?: string; /** * If set, the client can use this name with ByteStream.Read to stream the standard error. @@ -466,7 +469,7 @@ export namespace remotebuildexecution_v2 { */ resultsCachePolicy?: Schema$BuildBazelRemoteExecutionV2ResultsCachePolicy; /** - * If true, the action will be executed anew even if its result was already present in the cache. If false, the result may be served from the ActionCache. + * If true, the action will be executed even if its result is already present in the ActionCache. The execution is still allowed to be merged with other in-flight executions of the same action, however - semantically, the service MUST only guarantee that the results of an execution with this field set were not visible before the corresponding execution request was sent. Note that actions from execution requests setting this field set are still eligible to be entered into the action cache upon completion, and services SHOULD overwrite any existing entries that may exist. This allows skip_cache_lookup requests to be used as a mechanism for replacing action cache entries that reference outputs no longer available or that are poisoned in any way. If false, the result may be served from the action cache. */ skipCacheLookup?: boolean; } @@ -596,9 +599,13 @@ export namespace remotebuildexecution_v2 { treeDigest?: Schema$BuildBazelRemoteExecutionV2Digest; } /** - * An `OutputFile` is similar to a FileNode, but it is used as an output in an `ActionResult`. It allows a full file path rather than only a name. `OutputFile` is binary-compatible with `FileNode`. + * An `OutputFile` is similar to a FileNode, but it is used as an output in an `ActionResult`. It allows a full file path rather than only a name. */ export interface Schema$BuildBazelRemoteExecutionV2OutputFile { + /** + * The contents of the file if inlining was requested. The server SHOULD NOT inline file contents unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits. + */ + contents?: string; /** * The digest of the file's content. */ @@ -661,7 +668,7 @@ export namespace remotebuildexecution_v2 { minPriority?: number; } /** - * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: * name: `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` message. + * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: * name: `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` message. Note: the gRPC library serializes binary headers encoded in base 64 by default (https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests). Therefore, if the gRPC library is used to pass/retrieve this metadata, the user may ignore the base64 encoding and assume it is simply serialized as a binary message. */ export interface Schema$BuildBazelRemoteExecutionV2RequestMetadata { /** @@ -833,6 +840,19 @@ export namespace remotebuildexecution_v2 { */ numWarnings?: string; } + /** + * The internal status of the command result. + */ + export interface Schema$GoogleDevtoolsRemotebuildbotCommandStatus { + /** + * The status code. + */ + code?: string; + /** + * The error message. + */ + message?: string; + } /** * The request used for `CreateInstance`. */ @@ -937,6 +957,10 @@ export namespace remotebuildexecution_v2 { instances?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance[]; } export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest { + /** + * Optional. A filter to constrain the pools returned. Filters have the form: <field> <operator> <value> [[AND|OR] <field> <operator> <value>]... <field> is the path for a field or map key in the Pool proto message. e.g. "configuration.disk_size_gb" or "configuration.labels.key". <operator> can be one of "<", "<=", ">=", ">", "=", "!=", ":". ":" is a HAS operation for strings and repeated primitive fields. <value> is the value to test, case-insensitive for strings. "*" stands for any value and can be used to test for key presence. Parenthesis determine AND/OR precedence. In space separated restrictions, AND is implicit, e.g. "a = b x = y" is equivalent to "a = b AND x = y". Example filter: configuration.labels.key1 = * AND (state = RUNNING OR state = UPDATING) + */ + filter?: string; /** * Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ @@ -973,6 +997,10 @@ export namespace remotebuildexecution_v2 { * Required. Disk Type to use for the worker. See [Storage options](https://cloud.google.com/compute/docs/disks/#introduction). Currently only `pd-standard` is supported. */ diskType?: string; + /** + * Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Keys must start with a letter but values are optional. There can not be more than 64 labels per resource. + */ + labels?: {[key: string]: string}; /** * Required. Machine type of the worker, such as `n1-standard-2`. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that `f1-micro` and `g1-small` are not yet supported. */ @@ -1521,7 +1549,7 @@ export namespace remotebuildexecution_v2 { response?: {[key: string]: 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$GoogleRpcStatus { /** @@ -1546,12 +1574,15 @@ export namespace remotebuildexecution_v2 { /** * remotebuildexecution.actionResults.get - * @desc Retrieve a cached execution result. Errors: * `NOT_FOUND`: The requested `ActionResult` is not in the cache. + * @desc Retrieve a cached execution result. Implementations SHOULD ensure that any blobs referenced from the ContentAddressableStorage are available at the time of returning the ActionResult and will be for some period of time afterwards. The TTLs of the referenced blobs SHOULD be increased if necessary and applicable. Errors: * `NOT_FOUND`: The requested `ActionResult` is not in the cache. * @alias remotebuildexecution.actionResults.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.hash The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. + * @param {string=} params.inlineOutputFiles A hint to the server to inline the contents of the listed output files. Each path needs to exactly match one path in `output_files` in the Command message. + * @param {boolean=} params.inlineStderr A hint to the server to request inlining stderr in the ActionResult message. + * @param {boolean=} params.inlineStdout A hint to the server to request inlining stdout in the ActionResult message. * @param {string} params.instanceName The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted. * @param {string} params.sizeBytes The size of the blob, in bytes. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1744,6 +1775,18 @@ export namespace remotebuildexecution_v2 { * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. */ hash?: string; + /** + * A hint to the server to inline the contents of the listed output files. Each path needs to exactly match one path in `output_files` in the Command message. + */ + inlineOutputFiles?: string[]; + /** + * A hint to the server to request inlining stderr in the ActionResult message. + */ + inlineStderr?: boolean; + /** + * A hint to the server to request inlining stdout in the ActionResult message. + */ + inlineStdout?: boolean; /** * The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted. */ @@ -2493,7 +2536,7 @@ export namespace remotebuildexecution_v2 { /** * remotebuildexecution.getCapabilities - * @desc GetCapabilities returns the server capabilities configuration. + * @desc GetCapabilities returns the server capabilities configuration of the remote endpoint. Only the capabilities of the services supported by the endpoint will be returned: * Execution + CAS + Action Cache endpoints should return both CacheCapabilities and ExecutionCapabilities. * Execution only endpoints should return ExecutionCapabilities. * CAS + Action Cache only endpoints should return CacheCapabilities. * @alias remotebuildexecution.getCapabilities * @memberOf! () * diff --git a/src/apis/remotebuildexecution/webpack.config.js b/src/apis/remotebuildexecution/webpack.config.js index 39b995d7e5a..6c46a14ef78 100644 --- a/src/apis/remotebuildexecution/webpack.config.js +++ b/src/apis/remotebuildexecution/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/replicapool/package.json b/src/apis/replicapool/package.json index 97c3ce368a2..665023bc473 100644 --- a/src/apis/replicapool/package.json +++ b/src/apis/replicapool/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/replicapool/webpack.config.js b/src/apis/replicapool/webpack.config.js index ded91c6471b..239cf12e3a1 100644 --- a/src/apis/replicapool/webpack.config.js +++ b/src/apis/replicapool/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/reseller/package.json b/src/apis/reseller/package.json index 3391123b3ea..0931855b32d 100644 --- a/src/apis/reseller/package.json +++ b/src/apis/reseller/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/reseller/webpack.config.js b/src/apis/reseller/webpack.config.js index df45e3f8a29..5f94bf30a63 100644 --- a/src/apis/reseller/webpack.config.js +++ b/src/apis/reseller/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/run/index.ts b/src/apis/run/index.ts index 3fab8e0727a..c2213a5405a 100644 --- a/src/apis/run/index.ts +++ b/src/apis/run/index.ts @@ -16,19 +16,29 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {run_v1} from './v1'; import {run_v1alpha1} from './v1alpha1'; +import {run_v1beta1} from './v1beta1'; export const VERSIONS = { v1: run_v1.Run, v1alpha1: run_v1alpha1.Run, + v1beta1: run_v1beta1.Run, }; export function run(version: 'v1'): run_v1.Run; export function run(options: run_v1.Options): run_v1.Run; export function run(version: 'v1alpha1'): run_v1alpha1.Run; export function run(options: run_v1alpha1.Options): run_v1alpha1.Run; -export function run( +export function run(version: 'v1beta1'): run_v1beta1.Run; +export function run(options: run_v1beta1.Options): run_v1beta1.Run; +export function run( this: GoogleConfigurable, - versionOrOptions: 'v1' | run_v1.Options | 'v1alpha1' | run_v1alpha1.Options + versionOrOptions: + | 'v1' + | run_v1.Options + | 'v1alpha1' + | run_v1alpha1.Options + | 'v1beta1' + | run_v1beta1.Options ) { return getAPI('run', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/run/package.json b/src/apis/run/package.json index 864b1a49f1a..cb98fe29a3a 100644 --- a/src/apis/run/package.json +++ b/src/apis/run/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/run/v1alpha1.ts b/src/apis/run/v1alpha1.ts index 76aac180100..426f9cc17c7 100644 --- a/src/apis/run/v1alpha1.ts +++ b/src/apis/run/v1alpha1.ts @@ -123,7 +123,11 @@ export namespace run_v1alpha1 { * Information for connecting over HTTP(s). */ export interface Schema$Addressable { + /** + * Deprecated - use url instead. + */ hostname?: string; + url?: string; } /** * 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. @@ -207,12 +211,33 @@ export namespace run_v1alpha1 { */ optional?: boolean; } + /** + * Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. + */ + export interface Schema$ConfigMapVolumeSource { + /** + * Mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + */ + defaultMode?: number; + /** + * If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. + */ + items?: Schema$KeyToPath[]; + /** + * Name of the config. + */ + name?: string; + /** + * Specify whether the Secret or its keys must be defined. + */ + optional?: boolean; + } /** * Configuration represents the "floating HEAD" of a linear history of Revisions, and optionally how the containers those revisions reference are built. Users create new Revisions by updating the Configuration's spec. The "latest created" revision's name is available under status, as is the "latest ready" revision's name. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration */ export interface Schema$Configuration { /** - * The API version for this call such as "v1alpha1". + * The API version for this call such as "serving.knative.dev/v1alpha1". */ apiVersion?: string; /** @@ -248,6 +273,10 @@ export namespace run_v1alpha1 { * One-word CamelCase reason for the condition's last transition. +optional */ reason?: string; + /** + * How to interpret failures of this condition, one of Error, Warning, Info +optional + */ + severity?: string; /** * Status of the condition, one of True, False, Unknown. */ @@ -270,7 +299,7 @@ export namespace run_v1alpha1 { */ revisionTemplate?: Schema$RevisionTemplate; /** - * Template holds the latest specification for the Revision to be stamped out. Not currently supported by Cloud Run. + * Template holds the latest specification for the Revision to be stamped out. */ template?: Schema$RevisionTemplate; } @@ -414,7 +443,7 @@ export namespace run_v1alpha1 { */ export interface Schema$DomainMapping { /** - * The API version for this call such as "v1alpha1". + * The API version for this call such as "domains.cloudrun.com/v1alpha1". */ apiVersion?: string; /** @@ -438,6 +467,10 @@ export namespace run_v1alpha1 { * DomainMappingCondition contains state information for a DomainMapping. */ export interface Schema$DomainMappingCondition { + /** + * Last time the condition transitioned from one status to another. +optional + */ + lastTransitionTime?: string; /** * Human readable message indicating details about the current status. +optional */ @@ -446,6 +479,10 @@ export namespace run_v1alpha1 { * One-word CamelCase reason for the condition's current status. +optional */ reason?: string; + /** + * How to interpret failures of this condition, one of Error, Warning, Info +optional + */ + severity?: string; /** * Status of the condition, one of True, False, Unknown. */ @@ -527,6 +564,46 @@ export namespace run_v1alpha1 { */ value?: string; } + export interface Schema$EventType { + /** + * The API version for this call such as "eventing.knative.dev/v1alpha1". + */ + apiVersion?: string; + /** + * The kind of resource, in this case "EventType". + */ + kind?: string; + /** + * Metadata associated with this EventType. + */ + metadata?: Schema$ObjectMeta; + /** + * Spec defines the desired state of the EventType. + */ + spec?: Schema$EventTypeSpec; + } + export interface Schema$EventTypeSpec { + /** + * Refers to the Broker that can provide the EventType. + */ + broker?: string; + /** + * Description is a string describing what the EventType is about. +optional + */ + description?: string; + /** + * Schema is a URI with the EventType schema. It may be a JSON schema, a protobuf schema, etc. +optional + */ + schema?: string; + /** + * Source is a valid URI. Refers to the CloudEvent source as it enters into the eventing mesh. + */ + source?: string; + /** + * Type is authoritative. This refers to the CloudEvent type as it enters into the eventing mesh. + */ + type?: string; + } /** * ExecAction describes a "run in container" action. */ @@ -647,6 +724,23 @@ export namespace run_v1alpha1 { */ type?: string; } + /** + * Maps a string key to a path within a volume. + */ + export interface Schema$KeyToPath { + /** + * The key to project. + */ + key?: string; + /** + * Mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional + */ + mode?: number; + /** + * The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + */ + path?: string; + } /** * Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ @@ -678,7 +772,7 @@ export namespace run_v1alpha1 { */ export interface Schema$ListConfigurationsResponse { /** - * The API version for this call such as "v1alpha1". + * The API version for this call such as "serving.knative.dev/v1alpha1". */ apiVersion?: string; /** @@ -703,7 +797,7 @@ export namespace run_v1alpha1 { */ export interface Schema$ListDomainMappingsResponse { /** - * The API version for this call such as "v1alpha1". + * The API version for this call such as "domains.cloudrun.com/v1alpha1". */ apiVersion?: string; /** @@ -719,6 +813,31 @@ export namespace run_v1alpha1 { */ metadata?: Schema$ListMeta; } + /** + * ListEventTypesResponse is a list of EventType resources. + */ + export interface Schema$ListEventTypesResponse { + /** + * The API version for this call such as "eventing.knative.dev/v1alpha1". + */ + apiVersion?: string; + /** + * List of EventTypes. + */ + items?: Schema$EventType[]; + /** + * The kind of this resource, in this case "EventTypeList". + */ + kind?: string; + /** + * Metadata associated with this EventType list. + */ + metadata?: Schema$ListMeta; + /** + * Locations that could not be reached. + */ + unreachable?: string[]; + } /** * The response message for Locations.ListLocations. */ @@ -754,7 +873,7 @@ export namespace run_v1alpha1 { */ export interface Schema$ListRevisionsResponse { /** - * The API version for this call such as "v1alpha1". + * The API version for this call such as "serving.knative.dev/v1alpha1". */ apiVersion?: string; /** @@ -779,7 +898,7 @@ export namespace run_v1alpha1 { */ export interface Schema$ListRoutesResponse { /** - * The API version for this call such as "v1alpha1". + * The API version for this call such as "serving.knative.dev/v1alpha1". */ apiVersion?: string; /** @@ -804,7 +923,7 @@ export namespace run_v1alpha1 { */ export interface Schema$ListServicesResponse { /** - * The API version for this call such as "v1alpha1". + * The API version for this call such as "serving.knative.dev/v1alpha1". */ apiVersion?: string; /** @@ -829,7 +948,7 @@ export namespace run_v1alpha1 { */ export interface Schema$ListTriggersResponse { /** - * The API version for this call such as "v1alpha1". + * The API version for this call such as "eventing.knative.dev/v1alpha1". */ apiVersion?: string; /** @@ -1116,7 +1235,7 @@ export namespace run_v1alpha1 { */ export interface Schema$Revision { /** - * The API version for this call such as "v1alpha1". + * The API version for this call such as "serving.knative.dev/v1alpha1". */ apiVersion?: string; /** @@ -1152,6 +1271,10 @@ export namespace run_v1alpha1 { * One-word CamelCase reason for the condition's last transition. +optional */ reason?: string; + /** + * How to interpret failures of this condition, one of Error, Warning, Info +optional + */ + severity?: string; /** * Status of the condition, one of True, False, Unknown. */ @@ -1178,7 +1301,7 @@ export namespace run_v1alpha1 { */ containerConcurrency?: number; /** - * Containers holds the single container that defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. + * Containers holds the single container that defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. In Cloud Run, only a single container may be provided. */ containers?: Schema$Container[]; /** @@ -1186,7 +1309,7 @@ export namespace run_v1alpha1 { */ generation?: number; /** - * Not currently used by Cloud Run. + * Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account. */ serviceAccountName?: string; /** @@ -1197,6 +1320,7 @@ export namespace run_v1alpha1 { * TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Not currently used by Cloud Run. */ timeoutSeconds?: number; + volumes?: Schema$Volume[]; } /** * RevisionStatus communicates the observed state of the Revision (from the controller). @@ -1228,7 +1352,7 @@ export namespace run_v1alpha1 { */ export interface Schema$RevisionTemplate { /** - * Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. + * Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. To set minimum instances for this revision, use the "autoscaling.knative.dev/minScale" annotation key. (Cloud Run on GKE only). To set maximum instances for this revision, use the "autoscaling.knative.dev/maxScale" annotation key. To set Cloud SQL connections for the revision, use the "run.googleapis.com/cloudsql-instances" annotation key. Values should be comma separated. */ metadata?: Schema$ObjectMeta; /** @@ -1241,7 +1365,7 @@ export namespace run_v1alpha1 { */ export interface Schema$Route { /** - * The API version for this call such as "v1alpha1". + * The API version for this call such as "serving.knative.dev/v1alpha1". */ apiVersion?: string; /** @@ -1277,6 +1401,10 @@ export namespace run_v1alpha1 { * One-word CamelCase reason for the condition's last transition. +optional */ reason?: string; + /** + * How to interpret failures of this condition, one of Error, Warning, Info +optional + */ + severity?: string; /** * Status of the condition, one of "True", "False", "Unknown". */ @@ -1304,7 +1432,7 @@ export namespace run_v1alpha1 { */ export interface Schema$RouteStatus { /** - * Similar to domain, information on where the service is available on HTTP. + * Similar to url, information on where the service is available on HTTP. */ address?: Schema$Addressable; /** @@ -1312,11 +1440,11 @@ export namespace run_v1alpha1 { */ conditions?: Schema$RouteCondition[]; /** - * Domain holds the top-level domain that will distribute traffic over the provided targets. It generally has the form https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app + * Deprecated - use url instead. Domain holds the top-level domain that will distribute traffic over the provided targets. */ domain?: string; /** - * For Cloud Run, identifical to domain. + * Deprecated - use address instead. For Cloud Run, identifical to domain. */ domainInternal?: string; /** @@ -1327,6 +1455,10 @@ export namespace run_v1alpha1 { * Traffic holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that we last observed. */ traffic?: Schema$TrafficTarget[]; + /** + * URL holds the url that will distribute traffic over the provided traffic targets. It generally has the form https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app + */ + url?: string; } /** * SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables. @@ -1341,6 +1473,27 @@ export namespace run_v1alpha1 { */ optional?: boolean; } + /** + * The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. + */ + export interface Schema$SecretVolumeSource { + /** + * Mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + */ + defaultMode?: number; + /** + * If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. + */ + items?: Schema$KeyToPath[]; + /** + * Specify whether the Secret or its keys must be defined. + */ + optional?: boolean; + /** + * Name of the secret in the container's namespace to use. + */ + secretName?: string; + } /** * SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ @@ -1404,7 +1557,7 @@ export namespace run_v1alpha1 { */ export interface Schema$Service { /** - * The API version for this call such as "v1alpha1". + * The API version for this call such as "serving.knative.dev/v1alpha1". */ apiVersion?: string; /** @@ -1440,6 +1593,10 @@ export namespace run_v1alpha1 { * One-word CamelCase reason for the condition's last transition. +optional */ reason?: string; + /** + * How to interpret failures of this condition, one of Error, Warning, Info +optional + */ + severity?: string; /** * Status of the condition, one of True, False, Unknown. */ @@ -1474,11 +1631,11 @@ export namespace run_v1alpha1 { */ runLatest?: Schema$ServiceSpecRunLatest; /** - * Template holds the latest specification for the Revision to be stamped out. Not currently supported by Cloud Run. + * Template holds the latest specification for the Revision to be stamped out. */ template?: Schema$RevisionTemplate; /** - * Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations. This will replace existing service specs (ServiceSpecRunLatest, ServiceSpecPinnedType, ServiceSpecReleaseType, and ServiceSpecManualType). Not currently supported by Cloud Run. + * Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations. */ traffic?: Schema$TrafficTarget[]; } @@ -1530,7 +1687,7 @@ export namespace run_v1alpha1 { */ export interface Schema$ServiceStatus { /** - * From RouteStatus. Similar to domain, information on where the service is available on HTTP. + * From RouteStatus. Similar to url, information on where the service is available on HTTP. */ address?: Schema$Addressable; /** @@ -1557,6 +1714,10 @@ export namespace run_v1alpha1 { * From RouteStatus. Traffic holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that we last observed. */ traffic?: Schema$TrafficTarget[]; + /** + * From RouteStatus. URL holds the url that will distribute traffic over the provided traffic targets. It generally has the form https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app + */ + url?: string; } /** * Request message for `SetIamPolicy` method. @@ -1620,6 +1781,10 @@ export namespace run_v1alpha1 { * ConfigurationName of a configuration to whose latest revision we will send this portion of traffic. When the "status.latestReadyRevisionName" of the referenced configuration changes, we will automatically migrate traffic from the prior "latest ready" revision to the new one. This field is never set in Route's status, only its spec. This is mutually exclusive with RevisionName. Cloud Run currently supports a single ConfigurationName. */ configurationName?: string; + /** + * LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty; it must be false when RevisionName is non-empty. Not currently supported in Cloud Run. +optional + */ + latestRevision?: boolean; /** * Name is optionally used to expose a dedicated hostname for referencing this target exclusively. Not currently supported by Cloud Run. +optional */ @@ -1632,10 +1797,18 @@ export namespace run_v1alpha1 { * RevisionName of a specific revision to which to send this portion of traffic. This is mutually exclusive with ConfigurationName. Providing RevisionName in spec is not currently supported by Cloud Run. */ revisionName?: string; + /** + * Tag is optionally used to expose a dedicated url for referencing this target exclusively. Not currently supported in Cloud Run. +optional + */ + tag?: string; + /** + * Output only. URL displays the URL for accessing named traffic targets. URL is displayed in status, and is disallowed on spec. URL must contain a scheme (e.g. http://) and a hostname, but may not contain anything else (e.g. basic auth, url path, etc. Not currently supported in Cloud Run. + */ + url?: string; } export interface Schema$Trigger { /** - * The API version for this call such as "v1alpha1". + * The API version for this call such as "eventing.knative.dev/v1alpha1". */ apiVersion?: string; /** @@ -1671,6 +1844,10 @@ export namespace run_v1alpha1 { * One-word CamelCase reason for the condition's current status. +optional */ reason?: string; + /** + * How to interpret failures of this condition, one of Error, Warning, Info +optional + */ + severity?: string; /** * Status of the condition, one of True, False, Unknown. */ @@ -1724,6 +1901,17 @@ export namespace run_v1alpha1 { */ subscriberUri?: string; } + /** + * Volume represents a named volume in a container. + */ + export interface Schema$Volume { + configMap?: Schema$ConfigMapVolumeSource; + /** + * Volume's name. + */ + name?: string; + secret?: Schema$SecretVolumeSource; + } /** * volumeDevice describes a mapping of a raw block device within a container. */ @@ -1768,6 +1956,7 @@ export namespace run_v1alpha1 { authorizeddomains: Resource$Namespaces$Authorizeddomains; configurations: Resource$Namespaces$Configurations; domainmappings: Resource$Namespaces$Domainmappings; + eventtypes: Resource$Namespaces$Eventtypes; revisions: Resource$Namespaces$Revisions; routes: Resource$Namespaces$Routes; services: Resource$Namespaces$Services; @@ -1783,6 +1972,7 @@ export namespace run_v1alpha1 { this.domainmappings = new Resource$Namespaces$Domainmappings( this.context ); + this.eventtypes = new Resource$Namespaces$Eventtypes(this.context); this.revisions = new Resource$Namespaces$Revisions(this.context); this.routes = new Resource$Namespaces$Routes(this.context); this.services = new Resource$Namespaces$Services(this.context); @@ -2540,6 +2730,222 @@ export namespace run_v1alpha1 { watch?: boolean; } + export class Resource$Namespaces$Eventtypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.namespaces.eventtypes.get + * @desc Rpc to get information about an EventType. + * @alias run.namespaces.eventtypes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the 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$Namespaces$Eventtypes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Namespaces$Eventtypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Namespaces$Eventtypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Namespaces$Eventtypes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Eventtypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Eventtypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.namespaces.eventtypes.list + * @desc Rpc to list EventTypes. + * @alias run.namespaces.eventtypes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the EventTypes should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @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$Namespaces$Eventtypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Namespaces$Eventtypes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Namespaces$Eventtypes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Namespaces$Eventtypes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Eventtypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Eventtypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/apis/eventing.knative.dev/v1alpha1/{+parent}/eventtypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Namespaces$Eventtypes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Namespaces$Eventtypes$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional encoded string to continue paging. + */ + continue?: string; + /** + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + */ + fieldSelector?: string; + /** + * Not currently used by Cloud Run. + */ + includeUninitialized?: boolean; + /** + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + */ + labelSelector?: string; + /** + * The maximum number of records that should be returned. + */ + limit?: number; + /** + * The project ID or project number from which the EventTypes should be listed. + */ + parent?: string; + /** + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + */ + resourceVersion?: string; + /** + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + */ + watch?: boolean; + } + export class Resource$Namespaces$Revisions { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -4064,6 +4470,7 @@ export namespace run_v1alpha1 { authorizeddomains: Resource$Projects$Locations$Authorizeddomains; configurations: Resource$Projects$Locations$Configurations; domainmappings: Resource$Projects$Locations$Domainmappings; + eventtypes: Resource$Projects$Locations$Eventtypes; revisions: Resource$Projects$Locations$Revisions; routes: Resource$Projects$Locations$Routes; services: Resource$Projects$Locations$Services; @@ -4079,6 +4486,9 @@ export namespace run_v1alpha1 { this.domainmappings = new Resource$Projects$Locations$Domainmappings( this.context ); + this.eventtypes = new Resource$Projects$Locations$Eventtypes( + this.context + ); this.revisions = new Resource$Projects$Locations$Revisions(this.context); this.routes = new Resource$Projects$Locations$Routes(this.context); this.services = new Resource$Projects$Locations$Services(this.context); @@ -4934,6 +5344,220 @@ export namespace run_v1alpha1 { watch?: boolean; } + export class Resource$Projects$Locations$Eventtypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.eventtypes.get + * @desc Rpc to get information about an EventType. + * @alias run.projects.locations.eventtypes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the 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$Projects$Locations$Eventtypes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Eventtypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Eventtypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Eventtypes$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Eventtypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Eventtypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.eventtypes.list + * @desc Rpc to list EventTypes. + * @alias run.projects.locations.eventtypes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the EventTypes should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @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$Eventtypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Eventtypes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Eventtypes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Eventtypes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Eventtypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Eventtypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/eventtypes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Eventtypes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Eventtypes$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional encoded string to continue paging. + */ + continue?: string; + /** + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + */ + fieldSelector?: string; + /** + * Not currently used by Cloud Run. + */ + includeUninitialized?: boolean; + /** + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + */ + labelSelector?: string; + /** + * The maximum number of records that should be returned. + */ + limit?: number; + /** + * The project ID or project number from which the EventTypes should be listed. + */ + parent?: string; + /** + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + */ + resourceVersion?: string; + /** + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + */ + watch?: boolean; + } + export class Resource$Projects$Locations$Revisions { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -5685,6 +6309,7 @@ export namespace run_v1alpha1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6123,6 +6748,10 @@ export namespace run_v1alpha1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ diff --git a/src/apis/run/v1beta1.ts b/src/apis/run/v1beta1.ts new file mode 100644 index 00000000000..a4d1e60901d --- /dev/null +++ b/src/apis/run/v1beta1.ts @@ -0,0 +1,278 @@ +/** + * Copyright 2019 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. + */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace run_v1beta1 { + export interface Options extends GlobalOptions { + version: 'v1beta1'; + } + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Cloud Run API + * + * Deploy and manage user provided container images that scale automatically based on HTTP traffic. + * + * @example + * const {google} = require('googleapis'); + * const run = google.run('v1beta1'); + * + * @namespace run + * @type {Function} + * @version v1beta1 + * @variation v1beta1 + * @param {object=} options Options for Run + */ + export class Run { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * 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?: {[key: string]: string}; + /** + * 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?: {[key: string]: 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 { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.list + * @desc Lists information about the supported locations for this service. + * @alias run.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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * 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/run/webpack.config.js b/src/apis/run/webpack.config.js index c9a3bd7878b..947d5d8b4fd 100644 --- a/src/apis/run/webpack.config.js +++ b/src/apis/run/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/runtimeconfig/package.json b/src/apis/runtimeconfig/package.json index 865b01c4bb8..53b613393b9 100644 --- a/src/apis/runtimeconfig/package.json +++ b/src/apis/runtimeconfig/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/runtimeconfig/v1.ts b/src/apis/runtimeconfig/v1.ts index ce27d49a297..70d42340067 100644 --- a/src/apis/runtimeconfig/v1.ts +++ b/src/apis/runtimeconfig/v1.ts @@ -164,7 +164,7 @@ export namespace runtimeconfig_v1 { response?: {[key: string]: 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/runtimeconfig/v1beta1.ts b/src/apis/runtimeconfig/v1beta1.ts index a0bd3d04e13..e7f18f16f2a 100644 --- a/src/apis/runtimeconfig/v1beta1.ts +++ b/src/apis/runtimeconfig/v1beta1.ts @@ -285,7 +285,7 @@ export namespace runtimeconfig_v1beta1 { policy?: Schema$Policy; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/runtimeconfig/webpack.config.js b/src/apis/runtimeconfig/webpack.config.js index c2f8ecb6d86..9b43ea91f9a 100644 --- a/src/apis/runtimeconfig/webpack.config.js +++ b/src/apis/runtimeconfig/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/safebrowsing/package.json b/src/apis/safebrowsing/package.json index 22468e52c07..cdf6be64673 100644 --- a/src/apis/safebrowsing/package.json +++ b/src/apis/safebrowsing/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/safebrowsing/webpack.config.js b/src/apis/safebrowsing/webpack.config.js index 7aa1a7dc40c..4ba44ba0f0a 100644 --- a/src/apis/safebrowsing/webpack.config.js +++ b/src/apis/safebrowsing/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/script/package.json b/src/apis/script/package.json index 5111ac96b47..d448f610dec 100644 --- a/src/apis/script/package.json +++ b/src/apis/script/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/script/webpack.config.js b/src/apis/script/webpack.config.js index 2c6286673eb..a9831978229 100644 --- a/src/apis/script/webpack.config.js +++ b/src/apis/script/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/searchconsole/package.json b/src/apis/searchconsole/package.json index c4c045ed127..8e783e2ecc3 100644 --- a/src/apis/searchconsole/package.json +++ b/src/apis/searchconsole/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/searchconsole/webpack.config.js b/src/apis/searchconsole/webpack.config.js index f7b63586bab..0c3837ae1b4 100644 --- a/src/apis/searchconsole/webpack.config.js +++ b/src/apis/searchconsole/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/securitycenter/index.ts b/src/apis/securitycenter/index.ts index 671b61d377e..1736720b782 100644 --- a/src/apis/securitycenter/index.ts +++ b/src/apis/securitycenter/index.ts @@ -16,10 +16,12 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {securitycenter_v1} from './v1'; import {securitycenter_v1beta1} from './v1beta1'; +import {securitycenter_v1p1alpha1} from './v1p1alpha1'; export const VERSIONS = { v1: securitycenter_v1.Securitycenter, v1beta1: securitycenter_v1beta1.Securitycenter, + v1p1alpha1: securitycenter_v1p1alpha1.Securitycenter, }; export function securitycenter(version: 'v1'): securitycenter_v1.Securitycenter; @@ -32,8 +34,17 @@ export function securitycenter( export function securitycenter( options: securitycenter_v1beta1.Options ): securitycenter_v1beta1.Securitycenter; +export function securitycenter( + version: 'v1p1alpha1' +): securitycenter_v1p1alpha1.Securitycenter; +export function securitycenter( + options: securitycenter_v1p1alpha1.Options +): securitycenter_v1p1alpha1.Securitycenter; export function securitycenter< - T = securitycenter_v1.Securitycenter | securitycenter_v1beta1.Securitycenter + T = + | securitycenter_v1.Securitycenter + | securitycenter_v1beta1.Securitycenter + | securitycenter_v1p1alpha1.Securitycenter >( this: GoogleConfigurable, versionOrOptions: @@ -41,6 +52,8 @@ export function securitycenter< | securitycenter_v1.Options | 'v1beta1' | securitycenter_v1beta1.Options + | 'v1p1alpha1' + | securitycenter_v1p1alpha1.Options ) { return getAPI('securitycenter', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/securitycenter/package.json b/src/apis/securitycenter/package.json index 3de96d7f732..92c090f4517 100644 --- a/src/apis/securitycenter/package.json +++ b/src/apis/securitycenter/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index 976090d673d..228cd14a80d 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -164,7 +164,7 @@ export namespace securitycenter_v1 { projectIds?: string[]; } /** - * 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. + * 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:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -177,13 +177,17 @@ export namespace securitycenter_v1 { 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. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.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[]; + /** + * Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored. + */ + ignoreChildExemptions?: boolean; /** * The log type that this config enables. */ @@ -198,7 +202,7 @@ export namespace securitycenter_v1 { */ 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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * 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@example.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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** @@ -244,7 +248,7 @@ export namespace securitycenter_v1 { */ createTime?: string; /** - * The time at which the event took place. For example, if the finding represents an open firewall it would capture the time the open firewall was detected. + * The time at which the event took place. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. */ eventTime?: string; /** @@ -279,7 +283,21 @@ export namespace securitycenter_v1 { /** * Request message for `GetIamPolicy` method. */ - export interface Schema$GetIamPolicyRequest {} + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + */ + options?: Schema$GetPolicyOptions; + } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + requestedPolicyVersion?: number; + } /** * Response of asset discovery run */ @@ -577,7 +595,7 @@ export namespace securitycenter_v1 { */ 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` 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. */ etag?: string; /** @@ -662,7 +680,7 @@ export namespace securitycenter_v1 { */ description?: string; /** - * The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens, and underscores, and can be no longer than 32 characters. This is captured by the regular expression: [\p{L}\p{N}]({\p{L}\p{N}_- ]{0,30}[\p{L}\p{N}])?. + * The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). */ displayName?: string; /** @@ -671,7 +689,7 @@ export namespace securitycenter_v1 { name?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -721,6 +739,53 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.getOrganizationSettings * @desc Gets the settings for an organization. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of the organization to get organization settings for. Its format is + * // "organizations/[organization_id]/organizationSettings". + * name: 'organizations/my-organization/organizationSettings', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.getOrganizationSettings(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.getOrganizationSettings * @memberOf! () * @@ -797,6 +862,60 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.updateOrganizationSettings * @desc Updates an organization's settings. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The relative resource name of the settings. See: + * // https://cloud.google.com/apis/design/resource_names#relative_resource_name + * // Example: + * // "organizations/123/organizationSettings". + * name: 'organizations/my-organization/organizationSettings', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.updateOrganizationSettings(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.updateOrganizationSettings * @memberOf! () * @@ -916,6 +1035,70 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.assets.group * @desc Filters an organization's assets and groups them by their specified properties. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of the organization to groupBy. Its format is + * // "organizations/[organization_id]". + * parent: 'organizations/my-organization', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var groupByResultsPage = response['groupByResults']; + * if (!groupByResultsPage) { + * return; + * } + * for (var i = 0; i < groupByResultsPage.length; i++) { + * // TODO: Change code below to process each resource in `groupByResultsPage`: + * console.log(JSON.stringify(groupByResultsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.resource.pageToken = response.nextPageToken; + * securityCommandCenter.organizations.assets.group(request, handlePage); + * } + * }; + * + * securityCommandCenter.organizations.assets.group(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.assets.group * @memberOf! () * @@ -992,12 +1175,72 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.assets.list * @desc Lists an organization's assets. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of the organization assets should belong to. Its format is + * // "organizations/[organization_id]". + * parent: 'organizations/my-organization', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var listAssetsResultsPage = response['listAssetsResults']; + * if (!listAssetsResultsPage) { + * return; + * } + * for (var i = 0; i < listAssetsResultsPage.length; i++) { + * // TODO: Change code below to process each resource in `listAssetsResultsPage`: + * console.log(JSON.stringify(listAssetsResultsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * securityCommandCenter.organizations.assets.list(request, handlePage); + * } + * }; + * + * securityCommandCenter.organizations.assets.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.assets.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.compareDuration When compare_duration is set, the ListAssetsResult's "state_change" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at read_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at read_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time. - * @param {string=} params.fieldMask Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields. + * @param {string=} params.fieldMask Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields. * @param {string=} params.filter Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `>`, `<`, `>=`, `<=` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. * @param {string=} params.orderBy Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. The following fields are supported: name update_time resource_properties security_marks security_center_properties.resource_name security_center_properties.resource_parent security_center_properties.resource_project security_center_properties.resource_type * @param {integer=} params.pageSize The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. @@ -1074,6 +1317,57 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.assets.runDiscovery * @desc Runs asset discovery. The discovery is tracked with a long-running operation. This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of the organization to run asset discovery for. Its format is + * // "organizations/[organization_id]". + * parent: 'organizations/my-organization', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.assets.runDiscovery(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.assets.runDiscovery * @memberOf! () * @@ -1150,6 +1444,61 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.assets.updateSecurityMarks * @desc Updates security marks. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The relative resource name of the SecurityMarks. See: + * // https://cloud.google.com/apis/design/resource_names#relative_resource_name + * // Examples: + * // "organizations/123/assets/456/securityMarks" + * // "organizations/123/sources/456/findings/789/securityMarks". + * name: 'organizations/my-organization/assets/my-asset/securityMarks', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.assets.updateSecurityMarks(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.assets.updateSecurityMarks * @memberOf! () * @@ -1254,7 +1603,7 @@ export namespace securitycenter_v1 { */ compareDuration?: string; /** - * Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields. + * Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields. */ fieldMask?: string; /** @@ -1334,6 +1683,49 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.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`. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the operation resource to be cancelled. + * name: 'organizations/my-organization/operations/my-operation', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.operations.cancel(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.operations.cancel * @memberOf! () * @@ -1404,6 +1796,49 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.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`. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the operation resource to be deleted. + * name: 'organizations/my-organization/operations/my-operation', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.operations.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.operations.delete * @memberOf! () * @@ -1474,6 +1909,52 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.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. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the operation resource. + * name: 'organizations/my-organization/operations/my-operation', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.operations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.operations.get * @memberOf! () * @@ -1546,6 +2027,65 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.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. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the operation's parent resource. + * name: 'organizations/my-organization/operations', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var operationsPage = response['operations']; + * if (!operationsPage) { + * return; + * } + * for (var i = 0; i < operationsPage.length; i++) { + * // TODO: Change code below to process each resource in `operationsPage`: + * console.log(JSON.stringify(operationsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * securityCommandCenter.organizations.operations.list(request, handlePage); + * } + * }; + * + * securityCommandCenter.organizations.operations.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.operations.list * @memberOf! () * @@ -1693,6 +2233,57 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.create * @desc Creates a source. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Resource name of the new source's parent. Its format should be + * // "organizations/[organization_id]". + * parent: 'organizations/my-organization', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.sources.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.sources.create * @memberOf! () * @@ -1767,6 +2358,53 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.get * @desc Gets a source. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Relative resource name of the source. Its format is + * // "organizations/[organization_id]/source/[source_id]". + * name: 'organizations/my-organization/sources/my-source', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.sources.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.sources.get * @memberOf! () * @@ -1837,6 +2475,57 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.getIamPolicy * @desc Gets the access control policy on the specified Source. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'organizations/my-organization/sources/my-source', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.sources.getIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.sources.getIamPolicy * @memberOf! () * @@ -1911,6 +2600,66 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.list * @desc Lists all sources belonging to an organization. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Resource name of the parent of sources to list. Its format should be + * // "organizations/[organization_id]". + * parent: 'organizations/my-organization', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var sourcesPage = response['sources']; + * if (!sourcesPage) { + * return; + * } + * for (var i = 0; i < sourcesPage.length; i++) { + * // TODO: Change code below to process each resource in `sourcesPage`: + * console.log(JSON.stringify(sourcesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * securityCommandCenter.organizations.sources.list(request, handlePage); + * } + * }; + * + * securityCommandCenter.organizations.sources.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.sources.list * @memberOf! () * @@ -1988,6 +2737,60 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.patch * @desc Updates a source. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The relative resource name of this source. See: + * // https://cloud.google.com/apis/design/resource_names#relative_resource_name + * // Example: + * // "organizations/123/sources/456" + * name: 'organizations/my-organization/sources/my-source', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.sources.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.sources.patch * @memberOf! () * @@ -2060,6 +2863,57 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.setIamPolicy * @desc Sets the access control policy on the specified Source. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy is being specified. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'organizations/my-organization/sources/my-source', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.sources.setIamPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.sources.setIamPolicy * @memberOf! () * @@ -2134,6 +2988,57 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.testIamPermissions * @desc Returns the permissions that a caller has on the specified source. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // REQUIRED: The resource for which the policy detail is being requested. + * // See the operation documentation for the appropriate value for this field. + * resource_: 'organizations/my-organization/sources/my-source', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.sources.testIamPermissions(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.sources.testIamPermissions * @memberOf! () * @@ -2346,6 +3251,57 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.findings.create * @desc Creates a finding. The corresponding source must exist for finding creation to succeed. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Resource name of the new finding's parent. Its format should be + * // "organizations/[organization_id]/sources/[source_id]". + * parent: 'organizations/my-organization/sources/my-source', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.sources.findings.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.sources.findings.create * @memberOf! () * @@ -2421,6 +3377,72 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.findings.group * @desc Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/123/sources/-/findings + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of the source to groupBy. Its format is + * // "organizations/[organization_id]/sources/[source_id]". To groupBy across + * // all sources provide a source_id of `-`. For example: + * // organizations/123/sources/- + * parent: 'organizations/my-organization/sources/my-source', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var groupByResultsPage = response['groupByResults']; + * if (!groupByResultsPage) { + * return; + * } + * for (var i = 0; i < groupByResultsPage.length; i++) { + * // TODO: Change code below to process each resource in `groupByResultsPage`: + * console.log(JSON.stringify(groupByResultsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.resource.pageToken = response.nextPageToken; + * securityCommandCenter.organizations.sources.findings.group(request, handlePage); + * } + * }; + * + * securityCommandCenter.organizations.sources.findings.group(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.sources.findings.group * @memberOf! () * @@ -2499,12 +3521,74 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.findings.list * @desc Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/123/sources/-/findings + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of the source the findings belong to. Its format is + * // "organizations/[organization_id]/sources/[source_id]". To list across all + * // sources provide a source_id of `-`. For example: + * // organizations/123/sources/- + * parent: 'organizations/my-organization/sources/my-source', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var listFindingsResultsPage = response['listFindingsResults']; + * if (!listFindingsResultsPage) { + * return; + * } + * for (var i = 0; i < listFindingsResultsPage.length; i++) { + * // TODO: Change code below to process each resource in `listFindingsResultsPage`: + * console.log(JSON.stringify(listFindingsResultsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * securityCommandCenter.organizations.sources.findings.list(request, handlePage); + * } + * }; + * + * securityCommandCenter.organizations.sources.findings.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.sources.findings.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.compareDuration When compare_duration is set, the ListFindingsResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified: * "CHANGED": indicates that the finding was present at the start of compare_duration, but changed its state at read_time. * "UNCHANGED": indicates that the finding was present at the start of compare_duration and did not change state at read_time. * "ADDED": indicates that the finding was not present at the start of compare_duration, but was present at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time. - * @param {string=} params.fieldMask Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields. + * @param {string=} params.fieldMask Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields. * @param {string=} params.filter Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: name: `=` parent: `=`, `:` resource_name: `=`, `:` state: `=`, `:` category: `=`, `:` external_uri: `=`, `:` event_time: `>`, `<`, `>=`, `<=` security_marks: `=`, `:` source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. * @param {string=} params.orderBy Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks * @param {integer=} params.pageSize The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. @@ -2583,6 +3667,60 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.findings.patch * @desc Creates or updates a finding. The corresponding source must exist for a finding creation to succeed. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The relative resource name of this finding. See: + * // https://cloud.google.com/apis/design/resource_names#relative_resource_name + * // Example: + * // "organizations/123/sources/456/findings/789" + * name: 'organizations/my-organization/sources/my-source/findings/my-finding', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.sources.findings.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.sources.findings.patch * @memberOf! () * @@ -2655,6 +3793,59 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.findings.setState * @desc Updates the state of a finding. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The relative resource name of the finding. See: + * // https://cloud.google.com/apis/design/resource_names#relative_resource_name + * // Example: + * // "organizations/123/sources/456/finding/789". + * name: 'organizations/my-organization/sources/my-source/findings/my-finding', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.sources.findings.setState(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.sources.findings.setState * @memberOf! () * @@ -2729,6 +3920,61 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.findings.updateSecurityMarks * @desc Updates security marks. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Security Command Center API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/securitycenter + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var securityCommandCenter = google.securitycommandcenter('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The relative resource name of the SecurityMarks. See: + * // https://cloud.google.com/apis/design/resource_names#relative_resource_name + * // Examples: + * // "organizations/123/assets/456/securityMarks" + * // "organizations/123/sources/456/findings/789/securityMarks". + * name: 'organizations/my-organization/sources/my-source/findings/my-finding/securityMarks', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * securityCommandCenter.organizations.sources.findings.updateSecurityMarks(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias securitycenter.organizations.sources.findings.updateSecurityMarks * @memberOf! () * @@ -2854,7 +4100,7 @@ export namespace securitycenter_v1 { */ compareDuration?: string; /** - * Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields. + * Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields. */ fieldMask?: string; /** diff --git a/src/apis/securitycenter/v1beta1.ts b/src/apis/securitycenter/v1beta1.ts index 7b4f1c8a102..92c7c84e53b 100644 --- a/src/apis/securitycenter/v1beta1.ts +++ b/src/apis/securitycenter/v1beta1.ts @@ -160,7 +160,7 @@ export namespace securitycenter_v1beta1 { projectIds?: string[]; } /** - * 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. + * 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:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -173,13 +173,17 @@ export namespace securitycenter_v1beta1 { 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. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.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[]; + /** + * Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored. + */ + ignoreChildExemptions?: boolean; /** * The log type that this config enables. */ @@ -194,7 +198,7 @@ export namespace securitycenter_v1beta1 { */ 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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * 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@example.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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** @@ -244,7 +248,7 @@ export namespace securitycenter_v1beta1 { */ createTime?: string; /** - * The time at which the event took place. For example, if the finding represents an open firewall it would capture the time the open firewall was detected. + * The time at which the event took place. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. */ eventTime?: string; /** @@ -279,7 +283,21 @@ export namespace securitycenter_v1beta1 { /** * Request message for `GetIamPolicy` method. */ - export interface Schema$GetIamPolicyRequest {} + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + */ + options?: Schema$GetPolicyOptions; + } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + requestedPolicyVersion?: number; + } /** * Response of asset discovery run */ @@ -543,7 +561,7 @@ export namespace securitycenter_v1beta1 { */ 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` 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. */ etag?: string; /** @@ -628,7 +646,7 @@ export namespace securitycenter_v1beta1 { */ description?: string; /** - * The source’s display name. A source’s display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens, and underscores, and can be no longer than 32 characters. This is captured by the regular expression: [\p{L}\p{N}]({\p{L}\p{N}_- ]{0,30}[\p{L}\p{N}])?. + * The source’s display name. A source’s display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). */ displayName?: string; /** @@ -637,7 +655,7 @@ export namespace securitycenter_v1beta1 { name?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -963,7 +981,7 @@ export namespace securitycenter_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.compareDuration When compare_duration is set, the ListAssetResult's "state" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state" values when compare_duration is specified: * "ADDED": indicates that the asset was not present before compare_duration, but present at read_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at read_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state is "UNUSED", which indicates that the asset is present at read_time. - * @param {string=} params.fieldMask Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields. + * @param {string=} params.fieldMask Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields. * @param {string=} params.filter Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. For example, `resource_properties.size = 100` is a valid filter string. * @param {string=} params.orderBy Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. * @param {integer=} params.pageSize The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. @@ -1220,7 +1238,7 @@ export namespace securitycenter_v1beta1 { */ compareDuration?: string; /** - * Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields. + * Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields. */ fieldMask?: string; /** @@ -2478,7 +2496,7 @@ export namespace securitycenter_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.fieldMask Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields. + * @param {string=} params.fieldMask Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields. * @param {string=} params.filter Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. For example, `source_properties.size = 100` is a valid filter string. * @param {string=} params.orderBy Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. * @param {integer=} params.pageSize The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. @@ -2824,7 +2842,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields. + * Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields. */ fieldMask?: string; /** diff --git a/src/apis/securitycenter/v1p1alpha1.ts b/src/apis/securitycenter/v1p1alpha1.ts new file mode 100644 index 00000000000..01832c7eeff --- /dev/null +++ b/src/apis/securitycenter/v1p1alpha1.ts @@ -0,0 +1,583 @@ +/** + * Copyright 2019 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. + */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace securitycenter_v1p1alpha1 { + export interface Options extends GlobalOptions { + version: 'v1p1alpha1'; + } + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Cloud Security Command Center API + * + * Cloud Security Command Center API provides access to temporal views of assets and findings within an organization. + * + * @example + * const {google} = require('googleapis'); + * const securitycenter = google.securitycenter('v1p1alpha1'); + * + * @namespace securitycenter + * @type {Function} + * @version v1p1alpha1 + * @variation v1p1alpha1 + * @param {object=} options Options for Securitycenter + */ + export class Securitycenter { + context: APIRequestContext; + organizations: Resource$Organizations; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.organizations = new Resource$Organizations(this.context); + } + } + + /** + * 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 {} + /** + * Response of asset discovery run + */ + export interface Schema$GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse { + /** + * The duration between asset discovery run start and end + */ + duration?: string; + /** + * The state of an asset discovery run. + */ + state?: string; + } + /** + * Response of asset discovery run + */ + export interface Schema$GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse { + /** + * The duration between asset discovery run start and end + */ + duration?: string; + /** + * The state of an asset discovery run. + */ + state?: 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[]; + } + /** + * 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?: {[key: string]: 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 be a resource name ending with `operations/{unique_id}`. + */ + 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?: {[key: string]: 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + 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?: Array<{[key: string]: 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$Organizations { + context: APIRequestContext; + operations: Resource$Organizations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Organizations$Operations(this.context); + } + } + + export class Resource$Organizations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * securitycenter.organizations.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 securitycenter.organizations.operations.cancel + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be cancelled. + * @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$Organizations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Organizations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Organizations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Organizations$Operations$Cancel + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1alpha1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.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 securitycenter.organizations.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$Organizations$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Organizations$Operations$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1alpha1/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.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 securitycenter.organizations.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$Organizations$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Organizations$Operations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1alpha1/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.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 securitycenter.organizations.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$Organizations$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Operations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1alpha1/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Organizations$Operations$Cancel + extends StandardParameters { + /** + * 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; + } + export interface Params$Resource$Organizations$Operations$Delete + extends StandardParameters { + /** + * 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$Organizations$Operations$Get + extends StandardParameters { + /** + * 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$Organizations$Operations$List + extends StandardParameters { + /** + * 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; + } +} diff --git a/src/apis/securitycenter/webpack.config.js b/src/apis/securitycenter/webpack.config.js index 5538fd73e09..aa98163fbd2 100644 --- a/src/apis/securitycenter/webpack.config.js +++ b/src/apis/securitycenter/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/servicebroker/package.json b/src/apis/servicebroker/package.json index 8f12a43e7e3..06472cc15ca 100644 --- a/src/apis/servicebroker/package.json +++ b/src/apis/servicebroker/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/servicebroker/v1.ts b/src/apis/servicebroker/v1.ts index 522857138d9..66a523c04be 100644 --- a/src/apis/servicebroker/v1.ts +++ b/src/apis/servicebroker/v1.ts @@ -126,7 +126,7 @@ export namespace servicebroker_v1 { */ condition?: Schema$GoogleType__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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * 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@example.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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** @@ -143,7 +143,7 @@ export namespace servicebroker_v1 { */ bindings?: Schema$GoogleIamV1__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` 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. */ etag?: string; /** @@ -213,6 +213,7 @@ export namespace servicebroker_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -459,6 +460,10 @@ export namespace servicebroker_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ diff --git a/src/apis/servicebroker/v1alpha1.ts b/src/apis/servicebroker/v1alpha1.ts index 1df7925999f..65bf0ca3307 100644 --- a/src/apis/servicebroker/v1alpha1.ts +++ b/src/apis/servicebroker/v1alpha1.ts @@ -475,7 +475,7 @@ export namespace servicebroker_v1alpha1 { */ condition?: Schema$GoogleType__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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * 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@example.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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** @@ -492,7 +492,7 @@ export namespace servicebroker_v1alpha1 { */ bindings?: Schema$GoogleIamV1__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` 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. */ etag?: string; /** @@ -2304,6 +2304,7 @@ export namespace servicebroker_v1alpha1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2553,6 +2554,10 @@ export namespace servicebroker_v1alpha1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ diff --git a/src/apis/servicebroker/v1beta1.ts b/src/apis/servicebroker/v1beta1.ts index 7864d9040e5..78dc75b2c2f 100644 --- a/src/apis/servicebroker/v1beta1.ts +++ b/src/apis/servicebroker/v1beta1.ts @@ -533,7 +533,7 @@ export namespace servicebroker_v1beta1 { */ condition?: Schema$GoogleType__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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * 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@example.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}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** @@ -550,7 +550,7 @@ export namespace servicebroker_v1beta1 { */ bindings?: Schema$GoogleIamV1__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` 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. */ etag?: string; /** @@ -2857,6 +2857,7 @@ export namespace servicebroker_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3106,6 +3107,10 @@ export namespace servicebroker_v1beta1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + 'options.requestedPolicyVersion'?: number; /** * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. */ diff --git a/src/apis/servicebroker/webpack.config.js b/src/apis/servicebroker/webpack.config.js index 0bdfe6638d5..f8ab9c39d63 100644 --- a/src/apis/servicebroker/webpack.config.js +++ b/src/apis/servicebroker/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/serviceconsumermanagement/package.json b/src/apis/serviceconsumermanagement/package.json index f139c48f61b..970afe8c157 100644 --- a/src/apis/serviceconsumermanagement/package.json +++ b/src/apis/serviceconsumermanagement/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index c9b025f710f..ae36ba11638 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -461,6 +461,10 @@ export namespace serviceconsumermanagement_v1 { * A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$DocumentationRule[]; + /** + * Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. + */ + serviceRootUrl?: string; /** * A short summary of what the service does. Can only be provided by plain text. */ @@ -1225,7 +1229,7 @@ export namespace serviceconsumermanagement_v1 { sourceFiles?: Array<{[key: string]: 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -1535,7 +1539,7 @@ export namespace serviceconsumermanagement_v1 { */ email?: string; /** - * The IAM resource name of the service account in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. + * Deprecated. See b/136209818. */ iamAccountName?: string; /** diff --git a/src/apis/serviceconsumermanagement/webpack.config.js b/src/apis/serviceconsumermanagement/webpack.config.js index 8d0de8a65dd..d4190f1a13a 100644 --- a/src/apis/serviceconsumermanagement/webpack.config.js +++ b/src/apis/serviceconsumermanagement/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/servicecontrol/package.json b/src/apis/servicecontrol/package.json index 2504a361d5d..9b7551dd6f8 100644 --- a/src/apis/servicecontrol/package.json +++ b/src/apis/servicecontrol/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index 71b34e2a672..cff801abc2b 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -406,6 +406,10 @@ export namespace servicecontrol_v1 { * The total number of samples in the distribution. Must be >= 0. */ count?: string; + /** + * Example points. Must be in increasing order of `value` field. + */ + exemplars?: Schema$Exemplar[]; /** * Buckets with arbitrary user-provided width. */ @@ -435,6 +439,23 @@ export namespace servicecontrol_v1 { */ sumOfSquaredDeviation?: number; } + /** + * Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc. + */ + export interface Schema$Exemplar { + /** + * Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system. + */ + attachments?: Array<{[key: string]: any}>; + /** + * The observation (sampling) time of the above value. + */ + timestamp?: string; + /** + * Value of the exemplar point. This value determines to which bucket the exemplar belongs. + */ + value?: number; + } /** * Describing buckets with arbitrary user-provided width. */ @@ -1062,7 +1083,7 @@ export namespace servicecontrol_v1 { thirdPartyPrincipal?: Schema$ThirdPartyPrincipal; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/servicecontrol/webpack.config.js b/src/apis/servicecontrol/webpack.config.js index d7932baa7ef..30fc8bf0a50 100644 --- a/src/apis/servicecontrol/webpack.config.js +++ b/src/apis/servicecontrol/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/servicemanagement/package.json b/src/apis/servicemanagement/package.json index 0c6eb9ff3e3..368c27495cb 100644 --- a/src/apis/servicemanagement/package.json +++ b/src/apis/servicemanagement/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index ffd19982d31..40a0509b0ce 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -182,6 +182,10 @@ export namespace servicemanagement_v1 { * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; + /** + * Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored. + */ + ignoreChildExemptions?: boolean; /** * The log type that this config enables. */ @@ -221,15 +225,6 @@ export namespace servicemanagement_v1 { */ 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; - } /** * Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ @@ -551,6 +546,10 @@ export namespace servicemanagement_v1 { * A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$DocumentationRule[]; + /** + * Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. + */ + serviceRootUrl?: string; /** * A short summary of what the service does. Can only be provided by plain text. */ @@ -649,15 +648,6 @@ export namespace servicemanagement_v1 { */ 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; - } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ @@ -774,7 +764,21 @@ export namespace servicemanagement_v1 { /** * Request message for `GetIamPolicy` method. */ - export interface Schema$GetIamPolicyRequest {} + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + */ + options?: Schema$GetPolicyOptions; + } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + */ + requestedPolicyVersion?: number; + } /** * 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. */ @@ -1011,6 +1015,10 @@ export namespace servicemanagement_v1 { * 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. The launch stage of the metric definition. + */ + launchStage?: string; /** * Optional. Metadata which can be used to guide usage of the metric. */ @@ -1045,7 +1053,7 @@ export namespace servicemanagement_v1 { */ ingestDelay?: string; /** - * The launch stage of the metric definition. + * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. */ launchStage?: string; /** @@ -1160,7 +1168,7 @@ export namespace servicemanagement_v1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -1379,10 +1387,6 @@ export namespace servicemanagement_v1 { * 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. */ @@ -1480,7 +1484,7 @@ export namespace servicemanagement_v1 { sourceFiles?: Array<{[key: string]: 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -3658,6 +3662,7 @@ export namespace servicemanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.baseRolloutId Unimplemented. Do not use this feature until this comment is removed. The rollout id that rollout to be created based on. Rollout should be constructed based on current successful rollout, this field indicates the current successful rollout id that new rollout based on to construct, if current successful rollout changed when server receives the request, request will be rejected for safety. * @param {string} params.serviceName The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. * @param {().Rollout} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3893,6 +3898,10 @@ export namespace servicemanagement_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Unimplemented. Do not use this feature until this comment is removed. The rollout id that rollout to be created based on. Rollout should be constructed based on current successful rollout, this field indicates the current successful rollout id that new rollout based on to construct, if current successful rollout changed when server receives the request, request will be rejected for safety. + */ + baseRolloutId?: string; /** * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ diff --git a/src/apis/servicemanagement/webpack.config.js b/src/apis/servicemanagement/webpack.config.js index e998bff3f7d..f8d169d1f64 100644 --- a/src/apis/servicemanagement/webpack.config.js +++ b/src/apis/servicemanagement/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/servicenetworking/package.json b/src/apis/servicenetworking/package.json index 6f9f8844383..f827974ff2d 100644 --- a/src/apis/servicenetworking/package.json +++ b/src/apis/servicenetworking/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/servicenetworking/v1.ts b/src/apis/servicenetworking/v1.ts index 1c46de00a89..25c4dbcd467 100644 --- a/src/apis/servicenetworking/v1.ts +++ b/src/apis/servicenetworking/v1.ts @@ -449,6 +449,10 @@ export namespace servicenetworking_v1 { * A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$DocumentationRule[]; + /** + * Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. + */ + serviceRootUrl?: string; /** * A short summary of what the service does. Can only be provided by plain text. */ @@ -1208,7 +1212,7 @@ export namespace servicenetworking_v1 { sourceFiles?: Array<{[key: string]: 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index 274d5c9e417..5e721a4cc39 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -445,6 +445,10 @@ export namespace servicenetworking_v1beta { * A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$DocumentationRule[]; + /** + * Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. + */ + serviceRootUrl?: string; /** * A short summary of what the service does. Can only be provided by plain text. */ @@ -1187,7 +1191,7 @@ export namespace servicenetworking_v1beta { sourceFiles?: Array<{[key: string]: 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/servicenetworking/webpack.config.js b/src/apis/servicenetworking/webpack.config.js index cdf60ba4493..d8f13894aec 100644 --- a/src/apis/servicenetworking/webpack.config.js +++ b/src/apis/servicenetworking/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/serviceusage/package.json b/src/apis/serviceusage/package.json index f461523207d..8f0dac94e99 100644 --- a/src/apis/serviceusage/package.json +++ b/src/apis/serviceusage/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index 47e509adda0..5c7aa324a27 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -449,6 +449,10 @@ export namespace serviceusage_v1 { * A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$DocumentationRule[]; + /** + * Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. + */ + serviceRootUrl?: string; /** * A short summary of what the service does. Can only be provided by plain text. */ @@ -1284,7 +1288,7 @@ export namespace serviceusage_v1 { sourceFiles?: Array<{[key: string]: 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index 9df692043e8..e015897caf4 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -440,6 +440,10 @@ export namespace serviceusage_v1beta1 { * A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$DocumentationRule[]; + /** + * Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. + */ + serviceRootUrl?: string; /** * A short summary of what the service does. Can only be provided by plain text. */ @@ -1333,7 +1337,7 @@ export namespace serviceusage_v1beta1 { sourceFiles?: Array<{[key: string]: 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/serviceusage/webpack.config.js b/src/apis/serviceusage/webpack.config.js index 0079ba5694f..cc1dbf2f854 100644 --- a/src/apis/serviceusage/webpack.config.js +++ b/src/apis/serviceusage/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/sheets/package.json b/src/apis/sheets/package.json index 15ac0ba8ef7..b85cba46957 100644 --- a/src/apis/sheets/package.json +++ b/src/apis/sheets/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/sheets/v4.ts b/src/apis/sheets/v4.ts index 418748fe163..e4af343ba2a 100644 --- a/src/apis/sheets/v4.ts +++ b/src/apis/sheets/v4.ts @@ -3693,7 +3693,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { @@ -3832,7 +3832,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { @@ -3951,7 +3951,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { @@ -4082,7 +4082,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { @@ -4288,7 +4288,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { @@ -4413,7 +4413,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { @@ -4589,7 +4589,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { @@ -4751,7 +4751,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { @@ -4894,7 +4894,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { @@ -5026,7 +5026,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { @@ -5172,7 +5172,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { @@ -5315,7 +5315,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { @@ -5465,7 +5465,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { @@ -5603,7 +5603,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { @@ -5754,7 +5754,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { @@ -5883,7 +5883,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { @@ -6022,7 +6022,7 @@ export namespace sheets_v4 { * // 2. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var sheets = google.sheets('v4'); * * authorize(function(authClient) { diff --git a/src/apis/sheets/webpack.config.js b/src/apis/sheets/webpack.config.js index fd6e6e26306..75fb83ae2b5 100644 --- a/src/apis/sheets/webpack.config.js +++ b/src/apis/sheets/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/siteVerification/package.json b/src/apis/siteVerification/package.json index 432b20754b8..0eabe0382d8 100644 --- a/src/apis/siteVerification/package.json +++ b/src/apis/siteVerification/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/siteVerification/webpack.config.js b/src/apis/siteVerification/webpack.config.js index 1713b55b501..be0a7c0011b 100644 --- a/src/apis/siteVerification/webpack.config.js +++ b/src/apis/siteVerification/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/slides/package.json b/src/apis/slides/package.json index 7190996d436..5aa655a7a42 100644 --- a/src/apis/slides/package.json +++ b/src/apis/slides/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/slides/v1.ts b/src/apis/slides/v1.ts index 1658ab10369..23ac7aa69db 100644 --- a/src/apis/slides/v1.ts +++ b/src/apis/slides/v1.ts @@ -1134,7 +1134,7 @@ export namespace slides_v1 { */ export interface Schema$PageProperties { /** - * The color scheme of the page. If unset, the color scheme is inherited from a parent page. If the page has no parent, the color scheme uses a default Slides color scheme. This field is read-only. + * The color scheme of the page. If unset, the color scheme is inherited from a parent page. If the page has no parent, the color scheme uses a default Slides color scheme, matching the defaults in the Slides editor. Only the concrete colors of the first 12 ThemeColorTypes are editable. In addition, only the color scheme on Master pages can be updated. To update the field, a color scheme containing mappings from all the first 12 ThemeColorTypes to their concrete colors must be provided. Colors for the remaining ThemeColorTypes will be ignored. */ colorScheme?: Schema$ColorScheme; /** diff --git a/src/apis/slides/webpack.config.js b/src/apis/slides/webpack.config.js index 0ffefb7c0c8..bd3a95f1f3c 100644 --- a/src/apis/slides/webpack.config.js +++ b/src/apis/slides/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/sourcerepo/package.json b/src/apis/sourcerepo/package.json index d2c89c703a6..ba1c5ed8ce6 100644 --- a/src/apis/sourcerepo/package.json +++ b/src/apis/sourcerepo/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/sourcerepo/v1.ts b/src/apis/sourcerepo/v1.ts index 0f005ed7aab..fb142ab87f7 100644 --- a/src/apis/sourcerepo/v1.ts +++ b/src/apis/sourcerepo/v1.ts @@ -232,7 +232,7 @@ export namespace sourcerepo_v1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -334,7 +334,7 @@ export namespace sourcerepo_v1 { updateMask?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -350,6 +350,27 @@ export namespace sourcerepo_v1 { */ message?: string; } + /** + * Metadata of SyncRepo. This message is in the metadata field of Operation. + */ + export interface Schema$SyncRepoMetadata { + /** + * The name of the repo being synchronized. Values are of the form `projects/<project>/repos/<repo>`. + */ + name?: string; + /** + * The time this operation is started. + */ + startTime?: string; + /** + * The latest status message on syncing the repository. + */ + statusMessage?: string; + /** + * The time this operation's status message is updated. + */ + updateTime?: string; + } /** * Request for SyncRepo. */ diff --git a/src/apis/sourcerepo/webpack.config.js b/src/apis/sourcerepo/webpack.config.js index 4f2452f7ce2..46e8dcbd426 100644 --- a/src/apis/sourcerepo/webpack.config.js +++ b/src/apis/sourcerepo/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/spanner/package.json b/src/apis/spanner/package.json index 3d29e2a95ec..2ea48c57b47 100644 --- a/src/apis/spanner/package.json +++ b/src/apis/spanner/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index afcf0532d24..ca1db2c1058 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -282,32 +282,32 @@ export namespace spanner_v1 { */ export interface Schema$Empty {} /** - * The request for ExecuteBatchDml + * The request for ExecuteBatchDml. */ export interface Schema$ExecuteBatchDmlRequest { /** - * A per-transaction sequence number used to identify this request. This is used in the same space as the seqno in ExecuteSqlRequest. See more details in ExecuteSqlRequest. + * A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. */ seqno?: string; /** - * The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement i are visible to statement i+1. Each statement must be a DML statement. Execution will stop at the first failed statement; the remaining statements will not run. REQUIRES: `statements_size()` > 0. + * The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement `i` are visible to statement `i+1`. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed. Callers must provide at least one statement. */ statements?: Schema$Statement[]; /** - * The transaction to use. A ReadWrite transaction is required. Single-use transactions are not supported (to avoid replay). The caller must either supply an existing transaction ID or begin a new transaction. + * The transaction to use. Must be a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. */ transaction?: Schema$TransactionSelector; } /** - * The response for ExecuteBatchDml. Contains a list of ResultSet, one for each DML statement that has successfully executed. If a statement fails, the error is returned as part of the response payload. Clients can determine whether all DML statements have run successfully, or if a statement failed, using one of the following approaches: 1. Check if `'status'` field is `OkStatus`. 2. Check if `result_sets_size()` equals the number of statements in ExecuteBatchDmlRequest. Example 1: A request with 5 DML statements, all executed successfully. Result: A response with 5 ResultSets, one for each statement in the same order, and an `OkStatus`. Example 2: A request with 5 DML statements. The 3rd statement has a syntax error. Result: A response with 2 ResultSets, for the first 2 statements that run successfully, and a syntax error (`INVALID_ARGUMENT`) status. From `result_set_size()` client can determine that the 3rd statement has failed. + * The response for ExecuteBatchDml. Contains a list of ResultSet messages, one for each DML statement that has successfully executed, in the same order as the statements in the request. If a statement fails, the status in the response body identifies the cause of the failure. To check for DML statements that failed, use the following approach: 1. Check the status in the response message. The google.rpc.Code enum value `OK` indicates that all statements were executed successfully. 2. If the status was not `OK`, check the number of result sets in the response. If the response contains `N` ResultSet messages, then statement `N+1` in the request failed. Example 1: * Request: 5 DML statements, all executed successfully. * Response: 5 ResultSet messages, with the status `OK`. Example 2: * Request: 5 DML statements. The third statement has a syntax error. * Response: 2 ResultSet messages, and a syntax error (`INVALID_ARGUMENT`) status. The number of ResultSet messages indicates that the third statement failed, and the fourth and fifth statements were not executed. */ export interface Schema$ExecuteBatchDmlResponse { /** - * ResultSets, one for each statement in the request that ran successfully, in the same order as the statements in the request. Each ResultSet will not contain any rows. The ResultSetStats in each ResultSet will contain the number of rows modified by the statement. Only the first ResultSet in the response contains a valid ResultSetMetadata. + * One ResultSet for each statement in the request that ran successfully, in the same order as the statements in the request. Each ResultSet does not contain any rows. The ResultSetStats in each ResultSet contain the number of rows modified by the statement. Only the first ResultSet in the response contains valid ResultSetMetadata. */ resultSets?: Schema$ResultSet[]; /** - * If all DML statements are executed successfully, status will be OK. Otherwise, the error status of the first failed statement. + * If all DML statements are executed successfully, the status is `OK`. Otherwise, the error status of the first failed statement. */ status?: Schema$Status; } @@ -316,7 +316,7 @@ export namespace spanner_v1 { */ export interface Schema$ExecuteSqlRequest { /** - * The SQL string can contain parameter placeholders. A parameter placeholder consists of `'@'` followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute an SQL statement with unbound parameters. Parameter values are specified using `params`, which is a JSON object whose keys are parameter names, and whose values are the corresponding parameter values. + * Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters. */ params?: {[key: string]: any}; /** @@ -336,7 +336,7 @@ export namespace spanner_v1 { */ resumeToken?: string; /** - * A per-transaction sequence number used to identify this request. This makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. Required for DML statements. Ignored for queries. + * A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. Required for DML statements. Ignored for queries. */ seqno?: string; /** @@ -344,7 +344,7 @@ export namespace spanner_v1 { */ sql?: string; /** - * The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency. The transaction to use. For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency. Standard DML statements require a ReadWrite transaction. Single-use transactions are not supported (to avoid replay). The caller must either supply an existing transaction ID or begin a new transaction. Partitioned DML requires an existing PartitionedDml transaction ID. + * The transaction to use. For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency. Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. Partitioned DML requires an existing Partitioned DML transaction ID. */ transaction?: Schema$TransactionSelector; } @@ -586,7 +586,7 @@ export namespace spanner_v1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -650,7 +650,7 @@ export namespace spanner_v1 { */ export interface Schema$PartitionQueryRequest { /** - * The SQL query string can contain parameter placeholders. A parameter placeholder consists of `'@'` followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute an SQL query with unbound parameters. Parameter values are specified using `params`, which is a JSON object whose keys are parameter names, and whose values are the corresponding parameter values. + * Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters. */ params?: {[key: string]: any}; /** @@ -963,7 +963,7 @@ export namespace spanner_v1 { */ export interface Schema$Statement { /** - * The DML string can contain parameter placeholders. A parameter placeholder consists of `'@'` followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute an SQL statement with unbound parameters. Parameter values are specified using `params`, which is a JSON object whose keys are parameter names, and whose values are the corresponding parameter values. + * Parameter names and values that bind to placeholders in the DML string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters. */ params?: {[key: string]: any}; /** @@ -976,7 +976,7 @@ export namespace spanner_v1 { sql?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -3449,7 +3449,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.create - * @desc Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Cloud Spanner limits the number of sessions that can exist at any given time; thus, it is a good idea to delete idle and/or unneeded sessions. Aside from explicit deletes, Cloud Spanner can delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`. + * @desc Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner can delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`. * @alias spanner.projects.instances.databases.sessions.create * @memberOf! () * @@ -3591,7 +3591,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.executeBatchDml - * @desc Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql. Statements are executed in order, sequentially. ExecuteBatchDmlResponse will contain a ResultSet for each DML statement that has successfully executed. If a statement fails, its error status will be returned as part of the ExecuteBatchDmlResponse. Execution will stop at the first failed statement; the remaining statements will not run. ExecuteBatchDml is expected to return an OK status with a response even if there was an error while processing one of the DML statements. Clients must inspect response.status to determine if there were any errors while processing the request. See more details in ExecuteBatchDmlRequest and ExecuteBatchDmlResponse. + * @desc Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql. Statements are executed in sequential order. A request can succeed even if a statement fails. The ExecuteBatchDmlResponse.status field in the response provides information about the statement that failed. Clients must inspect this field to determine whether an error occurred. Execution stops after the first failed statement; the remaining statements are not executed. * @alias spanner.projects.instances.databases.sessions.executeBatchDml * @memberOf! () * diff --git a/src/apis/spanner/webpack.config.js b/src/apis/spanner/webpack.config.js index 7943259a61c..740b128d657 100644 --- a/src/apis/spanner/webpack.config.js +++ b/src/apis/spanner/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/speech/package.json b/src/apis/speech/package.json index fa018bef136..ff14ed67e03 100644 --- a/src/apis/speech/package.json +++ b/src/apis/speech/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/speech/v1.ts b/src/apis/speech/v1.ts index 1d0951e753e..3029e902c4a 100644 --- a/src/apis/speech/v1.ts +++ b/src/apis/speech/v1.ts @@ -190,7 +190,7 @@ export namespace speech_v1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -203,7 +203,7 @@ export namespace speech_v1 { */ export interface Schema$RecognitionAudio { /** - * The audio data bytes encoded as specified in `RecognitionConfig`. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + * The audio data bytes encoded as specified in `RecognitionConfig`. Note: as with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. */ content?: string; /** @@ -264,7 +264,7 @@ export namespace speech_v1 { */ speechContexts?: Schema$SpeechContext[]; /** - * *Optional* Set to true to use an enhanced model for speech recognition. If `use_enhanced` is set to true and the `model` field is not set, then an appropriate enhanced model is chosen if: 1. project is eligible for requesting enhanced models 2. an enhanced model exists for the audio If `use_enhanced` is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model. Enhanced speech models require that you opt-in to data logging using instructions in the [documentation](/speech-to-text/docs/enable-data-logging). If you set `use_enhanced` to true and you have not enabled audio logging, then you will receive an error. + * *Optional* Set to true to use an enhanced model for speech recognition. If `use_enhanced` is set to true and the `model` field is not set, then an appropriate enhanced model is chosen if an enhanced model exists for the audio. If `use_enhanced` is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model. */ useEnhanced?: boolean; } @@ -336,7 +336,7 @@ export namespace speech_v1 { */ export interface Schema$SpeechContext { /** - * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](/speech-to-text/quotas#content). + * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](/speech-to-text/quotas#content). List items can also be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months. */ phrases?: string[]; } @@ -371,7 +371,7 @@ export namespace speech_v1 { channelTag?: number; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -598,11 +598,9 @@ export namespace speech_v1 { export class Resource$Projects { context: APIRequestContext; locations: Resource$Projects$Locations; - operations: Resource$Projects$Operations; constructor(context: APIRequestContext) { this.context = context; this.locations = new Resource$Projects$Locations(this.context); - this.operations = new Resource$Projects$Operations(this.context); } } @@ -811,108 +809,6 @@ export namespace speech_v1 { pageToken?: string; } - export class Resource$Projects$Operations { - context: APIRequestContext; - manualRecognitionTasks: Resource$Projects$Operations$Manualrecognitiontasks; - constructor(context: APIRequestContext) { - this.context = context; - this.manualRecognitionTasks = new Resource$Projects$Operations$Manualrecognitiontasks( - this.context - ); - } - } - - export class Resource$Projects$Operations$Manualrecognitiontasks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * speech.projects.operations.manualRecognitionTasks.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 speech.projects.operations.manualRecognitionTasks.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$Projects$Operations$Manualrecognitiontasks$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Operations$Manualrecognitiontasks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Operations$Manualrecognitiontasks$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Operations$Manualrecognitiontasks$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Operations$Manualrecognitiontasks$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Operations$Manualrecognitiontasks$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://speech.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Operations$Manualrecognitiontasks$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the operation resource. - */ - name?: string; - } - export class Resource$Speech { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/speech/v1p1beta1.ts b/src/apis/speech/v1p1beta1.ts index e23d5f73551..2a821ed2135 100644 --- a/src/apis/speech/v1p1beta1.ts +++ b/src/apis/speech/v1p1beta1.ts @@ -190,7 +190,7 @@ export namespace speech_v1p1beta1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -203,7 +203,7 @@ export namespace speech_v1p1beta1 { */ export interface Schema$RecognitionAudio { /** - * The audio data bytes encoded as specified in `RecognitionConfig`. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + * The audio data bytes encoded as specified in `RecognitionConfig`. Note: as with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. */ content?: string; /** @@ -284,7 +284,7 @@ export namespace speech_v1p1beta1 { */ speechContexts?: Schema$SpeechContext[]; /** - * *Optional* Set to true to use an enhanced model for speech recognition. If `use_enhanced` is set to true and the `model` field is not set, then an appropriate enhanced model is chosen if: 1. project is eligible for requesting enhanced models 2. an enhanced model exists for the audio If `use_enhanced` is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model. Enhanced speech models require that you opt-in to data logging using instructions in the [documentation](/speech-to-text/docs/enable-data-logging). If you set `use_enhanced` to true and you have not enabled audio logging, then you will receive an error. + * *Optional* Set to true to use an enhanced model for speech recognition. If `use_enhanced` is set to true and the `model` field is not set, then an appropriate enhanced model is chosen if an enhanced model exists for the audio. If `use_enhanced` is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model. */ useEnhanced?: boolean; } @@ -374,7 +374,11 @@ export namespace speech_v1p1beta1 { */ export interface Schema$SpeechContext { /** - * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](/speech-to-text/quotas#content). + * Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. + */ + boost?: number; + /** + * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](/speech-to-text/quotas#content). List items can also be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months. */ phrases?: string[]; } @@ -413,7 +417,7 @@ export namespace speech_v1p1beta1 { languageCode?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -651,11 +655,9 @@ export namespace speech_v1p1beta1 { export class Resource$Projects { context: APIRequestContext; locations: Resource$Projects$Locations; - operations: Resource$Projects$Operations; constructor(context: APIRequestContext) { this.context = context; this.locations = new Resource$Projects$Locations(this.context); - this.operations = new Resource$Projects$Operations(this.context); } } @@ -864,108 +866,6 @@ export namespace speech_v1p1beta1 { pageToken?: string; } - export class Resource$Projects$Operations { - context: APIRequestContext; - manualRecognitionTasks: Resource$Projects$Operations$Manualrecognitiontasks; - constructor(context: APIRequestContext) { - this.context = context; - this.manualRecognitionTasks = new Resource$Projects$Operations$Manualrecognitiontasks( - this.context - ); - } - } - - export class Resource$Projects$Operations$Manualrecognitiontasks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * speech.projects.operations.manualRecognitionTasks.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 speech.projects.operations.manualRecognitionTasks.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$Projects$Operations$Manualrecognitiontasks$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Operations$Manualrecognitiontasks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Operations$Manualrecognitiontasks$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Operations$Manualrecognitiontasks$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Operations$Manualrecognitiontasks$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Operations$Manualrecognitiontasks$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://speech.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1p1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Operations$Manualrecognitiontasks$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the operation resource. - */ - name?: string; - } - export class Resource$Speech { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/speech/webpack.config.js b/src/apis/speech/webpack.config.js index a1a77a492e8..42fbe4aefe0 100644 --- a/src/apis/speech/webpack.config.js +++ b/src/apis/speech/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/sqladmin/package.json b/src/apis/sqladmin/package.json index 5afd8167be5..99ea8b7c326 100644 --- a/src/apis/sqladmin/package.json +++ b/src/apis/sqladmin/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index 600dad2fdc4..5b04ffee91e 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -829,7 +829,7 @@ export namespace sqladmin_v1beta4 { */ timeToRetire?: string; /** - * The type of this IP address. A PRIMARY address is an address that can accept incoming connections. An OUTGOING address is the source address of connections originating from the instance, if supported. + * The type of this IP address. A PRIMARY address is a public address that can accept incoming connections. A PRIVATE address is a private address that can accept incoming connections. An OUTGOING address is the source address of connections originating from the instance, if supported. */ type?: string; } @@ -1075,6 +1075,10 @@ export namespace sqladmin_v1beta4 { * This is always sql#restoreBackupContext. */ kind?: string; + /** + * The full project ID of the source instance. + */ + project?: string; } /** * Instance rotate server CA context. diff --git a/src/apis/sqladmin/webpack.config.js b/src/apis/sqladmin/webpack.config.js index 40b69174ce9..936d18c9d9c 100644 --- a/src/apis/sqladmin/webpack.config.js +++ b/src/apis/sqladmin/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/storage/package.json b/src/apis/storage/package.json index e023b5bdce6..3353afaa0da 100644 --- a/src/apis/storage/package.json +++ b/src/apis/storage/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index 924707c2a75..538d671fe22 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -163,6 +163,7 @@ export namespace storage_v1 { */ iamConfiguration?: { bucketPolicyOnly?: {enabled?: boolean; lockedTime?: string}; + uniformBucketLevelAccess?: {enabled?: boolean; lockedTime?: string}; }; /** * The ID of the bucket. For buckets, the id and name properties are the same. @@ -349,7 +350,7 @@ export namespace storage_v1 { */ id?: string; /** - * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". + * Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". */ kind?: string; /** @@ -410,10 +411,6 @@ export namespace storage_v1 { * 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; - /** - * The kind of item this is. For storage, this is always storage#expr. This field is ignored on input. - */ - kind?: string; /** * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ @@ -881,7 +878,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -905,16 +902,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.bucketAccessControls.delete @@ -1007,7 +1000,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -1034,16 +1027,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.bucketAccessControls.get @@ -1138,7 +1127,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -1165,16 +1154,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.bucketAccessControls.insert @@ -1269,7 +1254,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -1292,16 +1277,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.bucketAccessControls.list @@ -1397,7 +1378,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -1429,16 +1410,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.bucketAccessControls.patch @@ -1534,7 +1511,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -1566,16 +1543,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.bucketAccessControls.update @@ -1830,7 +1803,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -1850,16 +1823,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.buckets.delete @@ -1952,7 +1921,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -1975,16 +1944,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.buckets.get @@ -2078,7 +2043,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -2101,16 +2066,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.buckets.getIamPolicy @@ -2202,7 +2163,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -2229,16 +2190,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.buckets.insert @@ -2330,7 +2287,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -2366,16 +2323,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.buckets.list @@ -2452,6 +2405,55 @@ export namespace storage_v1 { /** * storage.buckets.lockRetentionPolicy * @desc Locks retention policy on a bucket. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Storage JSON API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/storage + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var storage = google.storage('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of a bucket. + * bucket: 'my-bucket', // TODO: Update placeholder value. + * + * // Makes the operation conditional on whether bucket's current metageneration matches the given value. + * ifMetagenerationMatch: '0', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * storage.buckets.lockRetentionPolicy(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias storage.buckets.lockRetentionPolicy * @memberOf! () * @@ -2541,7 +2543,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -2569,16 +2571,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.buckets.patch @@ -2675,7 +2673,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -2703,16 +2701,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.buckets.setIamPolicy @@ -2805,7 +2799,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -2831,16 +2825,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.buckets.testIamPermissions @@ -2941,7 +2931,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -2969,16 +2959,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.buckets.update @@ -3393,7 +3379,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -3414,16 +3400,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.channels.stop @@ -3531,7 +3513,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -3555,16 +3537,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.defaultObjectAccessControls.delete @@ -3656,7 +3634,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -3683,16 +3661,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.defaultObjectAccessControls.get @@ -3786,7 +3760,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -3813,16 +3787,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.defaultObjectAccessControls.insert @@ -3917,7 +3887,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -3940,16 +3910,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.defaultObjectAccessControls.list @@ -4047,7 +4013,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -4079,16 +4045,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.defaultObjectAccessControls.patch @@ -4183,7 +4145,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -4215,16 +4177,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.defaultObjectAccessControls.update @@ -4486,7 +4444,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -4509,16 +4467,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.notifications.delete @@ -4611,7 +4565,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -4637,16 +4591,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.notifications.get @@ -4741,7 +4691,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -4768,16 +4718,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.notifications.insert @@ -4871,7 +4817,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -4894,16 +4840,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.notifications.list @@ -5097,7 +5039,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -5125,16 +5067,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objectAccessControls.delete @@ -5228,7 +5166,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -5259,16 +5197,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objectAccessControls.get @@ -5364,7 +5298,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -5395,16 +5329,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objectAccessControls.insert @@ -5501,7 +5431,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -5528,16 +5458,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objectAccessControls.list @@ -5635,7 +5561,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -5671,16 +5597,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objectAccessControls.patch @@ -5777,7 +5699,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -5813,16 +5735,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objectAccessControls.update @@ -6126,12 +6044,12 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { * var request = { - * // Name of the bucket in which to store the new object. + * // Name of the bucket containing the source objects. The destination object is stored in this bucket. * destinationBucket: 'my-destination-bucket', // TODO: Update placeholder value. * * // Name of the new object. For information about how to URL encode object names to be path safe, see @@ -6157,16 +6075,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objects.compose @@ -6263,7 +6177,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -6303,16 +6217,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objects.copy @@ -6428,7 +6338,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -6452,16 +6362,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objects.delete @@ -6558,7 +6464,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -6589,16 +6495,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objects.get @@ -6696,7 +6598,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -6723,16 +6625,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objects.getIamPolicy @@ -6826,7 +6724,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -6861,16 +6759,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objects.insert @@ -6978,7 +6872,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -7014,16 +6908,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objects.list @@ -7121,7 +7011,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -7153,16 +7043,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objects.patch @@ -7262,7 +7148,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -7302,16 +7188,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objects.rewrite @@ -7432,7 +7314,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -7464,16 +7346,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objects.setIamPolicy @@ -7568,7 +7446,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -7598,16 +7476,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objects.testIamPermissions @@ -7710,7 +7584,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -7742,16 +7616,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objects.update @@ -7851,7 +7721,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -7878,16 +7748,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.objects.watchAll @@ -8675,6 +8541,55 @@ export namespace storage_v1 { /** * storage.projects.hmacKeys.create * @desc Creates a new HMAC key for the specified service account. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Storage JSON API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/storage + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var storage = google.storage('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID owning the service account. + * projectId: 'my-project-id', // TODO: Update placeholder value. + * + * // Email address of the service account. + * serviceAccountEmail: '', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * storage.projects.hmacKeys.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias storage.projects.hmacKeys.create * @memberOf! () * @@ -8748,6 +8663,52 @@ export namespace storage_v1 { /** * storage.projects.hmacKeys.delete * @desc Deletes an HMAC key. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Storage JSON API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/storage + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var storage = google.storage('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID owning the requested key + * projectId: 'my-project-id', // TODO: Update placeholder value. + * + * // Name of the HMAC key to be deleted. + * accessId: 'my-access-id', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * storage.projects.hmacKeys.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias storage.projects.hmacKeys.delete * @memberOf! () * @@ -8821,6 +8782,55 @@ export namespace storage_v1 { /** * storage.projects.hmacKeys.get * @desc Retrieves an HMAC key's metadata + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Storage JSON API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/storage + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var storage = google.storage('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID owning the service account of the requested key. + * projectId: 'my-project-id', // TODO: Update placeholder value. + * + * // Name of the HMAC key. + * accessId: 'my-access-id', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * storage.projects.hmacKeys.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias storage.projects.hmacKeys.get * @memberOf! () * @@ -8896,6 +8906,65 @@ export namespace storage_v1 { /** * storage.projects.hmacKeys.list * @desc Retrieves a list of HMAC keys matching the criteria. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Storage JSON API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/storage + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var storage = google.storage('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Name of the project in which to look for HMAC keys. + * projectId: 'my-project-id', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var itemsPage = response['items']; + * if (!itemsPage) { + * return; + * } + * for (var i = 0; i < itemsPage.length; i++) { + * // TODO: Change code below to process each resource in `itemsPage`: + * console.log(JSON.stringify(itemsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * storage.projects.hmacKeys.list(request, handlePage); + * } + * }; + * + * storage.projects.hmacKeys.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias storage.projects.hmacKeys.list * @memberOf! () * @@ -8974,6 +9043,60 @@ export namespace storage_v1 { /** * storage.projects.hmacKeys.update * @desc Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Storage JSON API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/storage + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var storage = google.storage('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID owning the service account of the updated key. + * projectId: 'my-project-id', // TODO: Update placeholder value. + * + * // Name of the HMAC key being updated. + * accessId: 'my-access-id', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. All existing properties + * // will be replaced. + * }, + * + * auth: authClient, + * }; + * + * storage.projects.hmacKeys.update(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias storage.projects.hmacKeys.update * @memberOf! () * @@ -9190,7 +9313,7 @@ export namespace storage_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storage = google.storage('v1'); * * authorize(function(authClient) { @@ -9213,16 +9336,12 @@ export namespace storage_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storage.projects.serviceAccount.get diff --git a/src/apis/storage/v1beta2.ts b/src/apis/storage/v1beta2.ts index 2eceb62d3a6..eb2d2b9a198 100644 --- a/src/apis/storage/v1beta2.ts +++ b/src/apis/storage/v1beta2.ts @@ -297,7 +297,7 @@ export namespace storage_v1beta2 { */ id?: string; /** - * Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". + * Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". */ kind?: string; /** diff --git a/src/apis/storage/webpack.config.js b/src/apis/storage/webpack.config.js index e50cafb8455..91eca8e0fa7 100644 --- a/src/apis/storage/webpack.config.js +++ b/src/apis/storage/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/storagetransfer/package.json b/src/apis/storagetransfer/package.json index 5a25b8b7cc5..70b14631f6e 100644 --- a/src/apis/storagetransfer/package.json +++ b/src/apis/storagetransfer/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/storagetransfer/v1.ts b/src/apis/storagetransfer/v1.ts index c3f6180b0ce..d8b28fadc84 100644 --- a/src/apis/storagetransfer/v1.ts +++ b/src/apis/storagetransfer/v1.ts @@ -128,11 +128,11 @@ export namespace storagetransfer_v1 { */ export interface Schema$AwsAccessKey { /** - * AWS access key ID. Required. + * Required. AWS access key ID. */ accessKeyId?: string; /** - * AWS secret access key. This field is not returned in RPC responses. Required. + * Required. AWS secret access key. This field is not returned in RPC responses. */ secretAccessKey?: string; } @@ -141,11 +141,11 @@ export namespace storagetransfer_v1 { */ export interface Schema$AwsS3Data { /** - * AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket must be granted to the access ID of the AWS access key. Required. + * Required. AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket must be granted to the access ID of the AWS access key. */ awsAccessKey?: Schema$AwsAccessKey; /** - * S3 Bucket name (see [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)). Required. + * Required. S3 Bucket name (see [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)). */ bucketName?: string; } @@ -179,7 +179,7 @@ export namespace storagetransfer_v1 { */ errorDetails?: string[]; /** - * A URL that refers to the target (a data source, a data sink, or an object) with which the error is associated. Required. + * Required. A URL that refers to the target (a data source, a data sink, or an object) with which the error is associated. */ url?: string; } @@ -192,7 +192,7 @@ export namespace storagetransfer_v1 { */ errorCode?: string; /** - * Count of this type of error. Required. + * Required. Count of this type of error. */ errorCount?: string; /** @@ -205,7 +205,7 @@ export namespace storagetransfer_v1 { */ export interface Schema$GcsData { /** - * Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/naming#requirements)). Required. + * Required. Google Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/naming#requirements)). */ bucketName?: string; } @@ -214,7 +214,7 @@ export namespace storagetransfer_v1 { */ export interface Schema$GoogleServiceAccount { /** - * Required. + * Email address of the service account. */ accountEmail?: string; } @@ -223,7 +223,7 @@ export namespace storagetransfer_v1 { */ export interface Schema$HttpData { /** - * The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. Required. + * Required. The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. */ listUrl?: string; } @@ -266,11 +266,11 @@ export namespace storagetransfer_v1 { */ includePrefixes?: string[]; /** - * If specified, only objects with a `lastModificationTime` on or after `NOW` - `maxTimeElapsedSinceLastModification` and objects that don't have a `lastModificationTime` are transferred. Note that `NOW` refers to the creation time of the transfer job, and `lastModificationTime` refers to the time of the last change to the object's content or metadata. Specifically, this would be the `updated` property of GCS objects and the `LastModified` field of S3 objects. + * If specified, only objects with a `lastModificationTime` on or after `NOW` - `maxTimeElapsedSinceLastModification` and objects that don't have a `lastModificationTime` are transferred. Note that, for each `TransferOperation` started by this `TransferJob`, `NOW` refers to the `start_time` of the 'TransferOperation`. Also, `lastModificationTime` refers to the time of the last change to the object's content or metadata - specifically, this would be the `updated` property of GCS objects and the `LastModified` field of S3 objects. */ maxTimeElapsedSinceLastModification?: string; /** - * If specified, only objects with a `lastModificationTime` before `NOW` - `minTimeElapsedSinceLastModification` and objects that don't have a `lastModificationTime` are transferred. Note that `NOW` refers to the creation time of the transfer job, and `lastModificationTime` refers to the time of the last change to the object's content or metadata. Specifically, this would be the `updated` property of GCS objects and the `LastModified` field of S3 objects. + * If specified, only objects with a `lastModificationTime` before `NOW` - `minTimeElapsedSinceLastModification` and objects that don't have a `lastModificationTime` are transferred. Note that, for each `TransferOperation` started by this `TransferJob`, `NOW` refers to the `start_time` of the 'TransferOperation`. Also, `lastModificationTime` refers to the time of the last change to the object's content or metadata - specifically, this would be the `updated` property of GCS objects and the `LastModified` field of S3 objects. */ minTimeElapsedSinceLastModification?: string; } @@ -316,7 +316,7 @@ export namespace storagetransfer_v1 { */ scheduleEndDate?: Schema$Date; /** - * The first day the recurring transfer is scheduled to run. If `scheduleStartDate` is in the past, the transfer will run for the first time on the following day. Required. + * Required. The first day the recurring transfer is scheduled to run. If `scheduleStartDate` is in the past, the transfer will run for the first time on the following day. */ scheduleStartDate?: Schema$Date; /** @@ -325,7 +325,7 @@ export namespace storagetransfer_v1 { startTimeOfDay?: Schema$TimeOfDay; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -493,7 +493,7 @@ export namespace storagetransfer_v1 { */ name?: string; /** - * The ID of the Google Cloud Platform Project that owns the operation. Required. + * The ID of the Google Cloud Platform Project that owns the operation. */ projectId?: string; /** @@ -509,7 +509,7 @@ export namespace storagetransfer_v1 { */ transferJobName?: string; /** - * Transfer specification. Required. + * Transfer specification. */ transferSpec?: Schema$TransferSpec; } @@ -564,11 +564,11 @@ export namespace storagetransfer_v1 { */ export interface Schema$UpdateTransferJobRequest { /** - * The ID of the Google Cloud Platform Console project that owns the job. Required. + * Required. The ID of the Google Cloud Platform Console project that owns the job. */ projectId?: string; /** - * The job to update. `transferJob` is expected to specify only three fields: `description`, `transferSpec`, and `status`. An UpdateTransferJobRequest that specifies other fields will be rejected with an error `INVALID_ARGUMENT`. Required. + * Required. The job to update. `transferJob` is expected to specify only three fields: `description`, `transferSpec`, and `status`. An UpdateTransferJobRequest that specifies other fields will be rejected with an error `INVALID_ARGUMENT`. */ transferJob?: Schema$TransferJob; /** @@ -589,7 +589,7 @@ export namespace storagetransfer_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Storage Transfer API + * // 1. If not already done, enable the Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer * // 2. This sample uses Application Default Credentials for authentication. @@ -601,14 +601,13 @@ export namespace storagetransfer_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storagetransfer = google.storagetransfer('v1'); * * authorize(function(authClient) { * var request = { - * // The ID of the Google Cloud Platform Console project that the Google service - * // account is associated with. - * // Required. + * // Required. The ID of the Google Cloud Platform Console project that the + * // Google service account is associated with. * projectId: 'my-project-id', // TODO: Update placeholder value. * * auth: authClient, @@ -626,23 +625,19 @@ export namespace storagetransfer_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storagetransfer.googleServiceAccounts.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId The ID of the Google Cloud Platform Console project that the Google service account is associated with. Required. + * @param {string} params.projectId Required. The ID of the Google Cloud Platform Console project that the Google service account is associated with. * @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 @@ -721,7 +716,7 @@ export namespace storagetransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Google Cloud Platform Console project that the Google service account is associated with. Required. + * Required. The ID of the Google Cloud Platform Console project that the Google service account is associated with. */ projectId?: string; } @@ -738,7 +733,7 @@ export namespace storagetransfer_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Storage Transfer API + * // 1. If not already done, enable the Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer * // 2. This sample uses Application Default Credentials for authentication. @@ -750,7 +745,7 @@ export namespace storagetransfer_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storagetransfer = google.storagetransfer('v1'); * * authorize(function(authClient) { @@ -774,16 +769,12 @@ export namespace storagetransfer_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storagetransfer.transferJobs.create @@ -861,7 +852,7 @@ export namespace storagetransfer_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Storage Transfer API + * // 1. If not already done, enable the Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer * // 2. This sample uses Application Default Credentials for authentication. @@ -873,13 +864,12 @@ export namespace storagetransfer_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storagetransfer = google.storagetransfer('v1'); * * authorize(function(authClient) { * var request = { - * // The job to get. - * // Required. + * // Required. The job to get. * jobName: 'transferJobs/my-transfer-job', // TODO: Update placeholder value. * * auth: authClient, @@ -897,24 +887,20 @@ export namespace storagetransfer_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storagetransfer.transferJobs.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.jobName The job to get. Required. - * @param {string=} params.projectId The ID of the Google Cloud Platform Console project that owns the job. Required. + * @param {string} params.jobName Required. The job to get. + * @param {string=} params.projectId Required. The ID of the Google Cloud Platform Console project that owns the job. * @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 @@ -984,7 +970,7 @@ export namespace storagetransfer_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Storage Transfer API + * // 1. If not already done, enable the Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer * // 2. This sample uses Application Default Credentials for authentication. @@ -996,7 +982,7 @@ export namespace storagetransfer_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storagetransfer = google.storagetransfer('v1'); * * authorize(function(authClient) { @@ -1029,23 +1015,19 @@ export namespace storagetransfer_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storagetransfer.transferJobs.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter A list of query parameters specified as JSON text in the form of {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "job_statuses":["status1","status2",...]}. Since `job_names` and `job_statuses` support multiple values, their values must be specified with array notation. `project_id` is required. `job_names` and `job_statuses` are optional. The valid values for `job_statuses` are case-insensitive: `ENABLED`, `DISABLED`, and `DELETED`. + * @param {string=} params.filter Required. A list of query parameters specified as JSON text in the form of: {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "job_statuses":["status1","status2",...]}. Since `job_names` and `job_statuses` support multiple values, their values must be specified with array notation. `project_id` is required. `job_names` and `job_statuses` are optional. The valid values for `job_statuses` are case-insensitive: `ENABLED`, `DISABLED`, and `DELETED`. * @param {integer=} params.pageSize The list page size. The max allowed value is 256. * @param {string=} params.pageToken The list page token. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1120,7 +1102,7 @@ export namespace storagetransfer_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Storage Transfer API + * // 1. If not already done, enable the Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer * // 2. This sample uses Application Default Credentials for authentication. @@ -1132,13 +1114,12 @@ export namespace storagetransfer_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storagetransfer = google.storagetransfer('v1'); * * authorize(function(authClient) { * var request = { - * // The name of job to update. - * // Required. + * // Required. The name of job to update. * jobName: 'transferJobs/my-transfer-job', // TODO: Update placeholder value. * * resource: { @@ -1161,23 +1142,19 @@ export namespace storagetransfer_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storagetransfer.transferJobs.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.jobName The name of job to update. Required. + * @param {string} params.jobName Required. The name of job to update. * @param {().UpdateTransferJobRequest} 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. @@ -1263,11 +1240,11 @@ export namespace storagetransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The job to get. Required. + * Required. The job to get. */ jobName?: string; /** - * The ID of the Google Cloud Platform Console project that owns the job. Required. + * Required. The ID of the Google Cloud Platform Console project that owns the job. */ projectId?: string; } @@ -1279,7 +1256,7 @@ export namespace storagetransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A list of query parameters specified as JSON text in the form of {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "job_statuses":["status1","status2",...]}. Since `job_names` and `job_statuses` support multiple values, their values must be specified with array notation. `project_id` is required. `job_names` and `job_statuses` are optional. The valid values for `job_statuses` are case-insensitive: `ENABLED`, `DISABLED`, and `DELETED`. + * Required. A list of query parameters specified as JSON text in the form of: {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "job_statuses":["status1","status2",...]}. Since `job_names` and `job_statuses` support multiple values, their values must be specified with array notation. `project_id` is required. `job_names` and `job_statuses` are optional. The valid values for `job_statuses` are case-insensitive: `ENABLED`, `DISABLED`, and `DELETED`. */ filter?: string; /** @@ -1299,7 +1276,7 @@ export namespace storagetransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of job to update. Required. + * Required. The name of job to update. */ jobName?: string; @@ -1321,7 +1298,7 @@ export namespace storagetransfer_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Storage Transfer API + * // 1. If not already done, enable the Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer * // 2. This sample uses Application Default Credentials for authentication. @@ -1333,7 +1310,7 @@ export namespace storagetransfer_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storagetransfer = google.storagetransfer('v1'); * * authorize(function(authClient) { @@ -1353,16 +1330,12 @@ export namespace storagetransfer_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storagetransfer.transferOperations.cancel @@ -1438,7 +1411,7 @@ export namespace storagetransfer_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Storage Transfer API + * // 1. If not already done, enable the Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer * // 2. This sample uses Application Default Credentials for authentication. @@ -1450,7 +1423,7 @@ export namespace storagetransfer_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storagetransfer = google.storagetransfer('v1'); * * authorize(function(authClient) { @@ -1470,16 +1443,12 @@ export namespace storagetransfer_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storagetransfer.transferOperations.delete @@ -1555,7 +1524,7 @@ export namespace storagetransfer_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Storage Transfer API + * // 1. If not already done, enable the Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer * // 2. This sample uses Application Default Credentials for authentication. @@ -1567,7 +1536,7 @@ export namespace storagetransfer_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storagetransfer = google.storagetransfer('v1'); * * authorize(function(authClient) { @@ -1590,16 +1559,12 @@ export namespace storagetransfer_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storagetransfer.transferOperations.get @@ -1677,7 +1642,7 @@ export namespace storagetransfer_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Storage Transfer API + * // 1. If not already done, enable the Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer * // 2. This sample uses Application Default Credentials for authentication. @@ -1689,12 +1654,12 @@ export namespace storagetransfer_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storagetransfer = google.storagetransfer('v1'); * * authorize(function(authClient) { * var request = { - * // The value `transferOperations`. + * // Required. The value `transferOperations`. * name: 'transferOperations', // TODO: Update placeholder value. * * auth: authClient, @@ -1725,24 +1690,20 @@ export namespace storagetransfer_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storagetransfer.transferOperations.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter A list of query parameters specified as JSON text in the form of {\"project_id\" : \"my_project_id\", \"job_names\" : [\"jobid1\", \"jobid2\",...], \"operation_names\" : [\"opid1\", \"opid2\",...], \"transfer_statuses\":[\"status1\", \"status2\",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `job_names`, `operation_names`, and `transfer_statuses` are optional. - * @param {string} params.name The value `transferOperations`. + * @param {string=} params.filter Required. A list of query parameters specified as JSON text in the form of: {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "operation_names":["opid1","opid2",...], "transfer_statuses":["status1","status2",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `project_id` is required. `job_names`, `operation_names`, and `transfer_statuses` are optional. The valid values for `transfer_statuses` are case-insensitive: `IN_PROGRESS`, `PAUSED`, `SUCCESS`, `FAILED`, and `ABORTED`. + * @param {string} params.name Required. The value `transferOperations`. * @param {integer=} params.pageSize The list page size. The max allowed value is 256. * @param {string=} params.pageToken The list page token. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1817,7 +1778,7 @@ export namespace storagetransfer_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Storage Transfer API + * // 1. If not already done, enable the Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer * // 2. This sample uses Application Default Credentials for authentication. @@ -1829,13 +1790,12 @@ export namespace storagetransfer_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storagetransfer = google.storagetransfer('v1'); * * authorize(function(authClient) { * var request = { - * // The name of the transfer operation. - * // Required. + * // Required. The name of the transfer operation. * name: 'transferOperations/my-transfer-operation', // TODO: Update placeholder value. * * resource: { @@ -1854,23 +1814,19 @@ export namespace storagetransfer_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storagetransfer.transferOperations.pause * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the transfer operation. Required. + * @param {string} params.name Required. The name of the transfer operation. * @param {().PauseTransferOperationRequest} 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. @@ -1940,7 +1896,7 @@ export namespace storagetransfer_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Storage Transfer API + * // 1. If not already done, enable the Storage Transfer API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/storagetransfer * // 2. This sample uses Application Default Credentials for authentication. @@ -1952,13 +1908,12 @@ export namespace storagetransfer_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var storagetransfer = google.storagetransfer('v1'); * * authorize(function(authClient) { * var request = { - * // The name of the transfer operation. - * // Required. + * // Required. The name of the transfer operation. * name: 'transferOperations/my-transfer-operation', // TODO: Update placeholder value. * * resource: { @@ -1977,23 +1932,19 @@ export namespace storagetransfer_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias storagetransfer.transferOperations.resume * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the transfer operation. Required. + * @param {string} params.name Required. The name of the transfer operation. * @param {().ResumeTransferOperationRequest} 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. @@ -2102,11 +2053,11 @@ export namespace storagetransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A list of query parameters specified as JSON text in the form of {\"project_id\" : \"my_project_id\", \"job_names\" : [\"jobid1\", \"jobid2\",...], \"operation_names\" : [\"opid1\", \"opid2\",...], \"transfer_statuses\":[\"status1\", \"status2\",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `job_names`, `operation_names`, and `transfer_statuses` are optional. + * Required. A list of query parameters specified as JSON text in the form of: {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "operation_names":["opid1","opid2",...], "transfer_statuses":["status1","status2",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `project_id` is required. `job_names`, `operation_names`, and `transfer_statuses` are optional. The valid values for `transfer_statuses` are case-insensitive: `IN_PROGRESS`, `PAUSED`, `SUCCESS`, `FAILED`, and `ABORTED`. */ filter?: string; /** - * The value `transferOperations`. + * Required. The value `transferOperations`. */ name?: string; /** @@ -2126,7 +2077,7 @@ export namespace storagetransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the transfer operation. Required. + * Required. The name of the transfer operation. */ name?: string; @@ -2143,7 +2094,7 @@ export namespace storagetransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the transfer operation. Required. + * Required. The name of the transfer operation. */ name?: string; diff --git a/src/apis/storagetransfer/webpack.config.js b/src/apis/storagetransfer/webpack.config.js index 2b8cd640aea..3b1fbbe10c2 100644 --- a/src/apis/storagetransfer/webpack.config.js +++ b/src/apis/storagetransfer/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/streetviewpublish/package.json b/src/apis/streetviewpublish/package.json index dc62841baf4..52a6b5ae177 100644 --- a/src/apis/streetviewpublish/package.json +++ b/src/apis/streetviewpublish/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/streetviewpublish/v1.ts b/src/apis/streetviewpublish/v1.ts index 64c66d9510f..db93e9fd680 100644 --- a/src/apis/streetviewpublish/v1.ts +++ b/src/apis/streetviewpublish/v1.ts @@ -367,7 +367,7 @@ export namespace streetviewpublish_v1 { roll?: number; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/streetviewpublish/webpack.config.js b/src/apis/streetviewpublish/webpack.config.js index ce376bbea46..0897c3c8674 100644 --- a/src/apis/streetviewpublish/webpack.config.js +++ b/src/apis/streetviewpublish/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/surveys/package.json b/src/apis/surveys/package.json index f6c73b2e5bb..1f0db6ee178 100644 --- a/src/apis/surveys/package.json +++ b/src/apis/surveys/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/surveys/webpack.config.js b/src/apis/surveys/webpack.config.js index a45c9ffdda5..776e099e242 100644 --- a/src/apis/surveys/webpack.config.js +++ b/src/apis/surveys/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/tagmanager/package.json b/src/apis/tagmanager/package.json index 7fcdd5cb735..ab660ca3f0e 100644 --- a/src/apis/tagmanager/package.json +++ b/src/apis/tagmanager/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/tagmanager/v1.ts b/src/apis/tagmanager/v1.ts index d0b1017e8f7..fef955ad1d1 100644 --- a/src/apis/tagmanager/v1.ts +++ b/src/apis/tagmanager/v1.ts @@ -593,7 +593,7 @@ export namespace tagmanager_v1 { */ map?: Schema$Parameter[]; /** - * The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + * The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id */ type?: string; /** diff --git a/src/apis/tagmanager/v2.ts b/src/apis/tagmanager/v2.ts index c69ad07c74c..f4ec7b78a3d 100644 --- a/src/apis/tagmanager/v2.ts +++ b/src/apis/tagmanager/v2.ts @@ -706,6 +706,16 @@ export namespace tagmanager_v2 { */ tag?: Schema$Tag[]; } + export interface Schema$ListTemplatesResponse { + /** + * Continuation token for fetching the next page of results. + */ + nextPageToken?: string; + /** + * All GTM Custom Templates of a GTM Container. + */ + template?: Schema$CustomTemplate[]; + } /** * List triggers response. */ @@ -798,7 +808,7 @@ export namespace tagmanager_v2 { */ map?: Schema$Parameter[]; /** - * The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + * The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id */ type?: string; /** @@ -863,6 +873,15 @@ export namespace tagmanager_v2 { */ tag?: Schema$Tag; } + /** + * The result of reverting a template in a workspace. + */ + export interface Schema$RevertTemplateResponse { + /** + * Template as it appears in the latest container version since the last workspace synchronization operation. If no template is present, that means the template was deleted in the latest container version. + */ + template?: Schema$CustomTemplate; + } /** * The result of reverting a trigger in a workspace. */ @@ -3583,6 +3602,7 @@ export namespace tagmanager_v2 { built_in_variables: Resource$Accounts$Containers$Workspaces$Built_in_variables; folders: Resource$Accounts$Containers$Workspaces$Folders; tags: Resource$Accounts$Containers$Workspaces$Tags; + templates: Resource$Accounts$Containers$Workspaces$Templates; triggers: Resource$Accounts$Containers$Workspaces$Triggers; variables: Resource$Accounts$Containers$Workspaces$Variables; zones: Resource$Accounts$Containers$Workspaces$Zones; @@ -3597,6 +3617,9 @@ export namespace tagmanager_v2 { this.tags = new Resource$Accounts$Containers$Workspaces$Tags( this.context ); + this.templates = new Resource$Accounts$Containers$Workspaces$Templates( + this.context + ); this.triggers = new Resource$Accounts$Containers$Workspaces$Triggers( this.context ); @@ -6208,6 +6231,559 @@ export namespace tagmanager_v2 { requestBody?: Schema$Tag; } + export class Resource$Accounts$Containers$Workspaces$Templates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * tagmanager.accounts.containers.workspaces.templates.create + * @desc Creates a GTM Custom Template. + * @alias tagmanager.accounts.containers.workspaces.templates.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + * @param {().CustomTemplate} 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$Accounts$Containers$Workspaces$Templates$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Accounts$Containers$Workspaces$Templates$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Accounts$Containers$Workspaces$Templates$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Accounts$Containers$Workspaces$Templates$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Containers$Workspaces$Templates$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Containers$Workspaces$Templates$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/tagmanager/v2/{+parent}/templates').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * tagmanager.accounts.containers.workspaces.templates.delete + * @desc Deletes a GTM Template. + * @alias tagmanager.accounts.containers.workspaces.templates.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.path GTM Custom Template's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/templates/{template_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 + */ + delete( + params?: Params$Resource$Accounts$Containers$Workspaces$Templates$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Accounts$Containers$Workspaces$Templates$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Accounts$Containers$Workspaces$Templates$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Accounts$Containers$Workspaces$Templates$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Containers$Workspaces$Templates$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Containers$Workspaces$Templates$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/tagmanager/v2/{+path}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['path'], + pathParams: ['path'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * tagmanager.accounts.containers.workspaces.templates.get + * @desc Gets a GTM Template. + * @alias tagmanager.accounts.containers.workspaces.templates.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.path GTM Custom Template's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/templates/{template_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$Accounts$Containers$Workspaces$Templates$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Accounts$Containers$Workspaces$Templates$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Containers$Workspaces$Templates$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accounts$Containers$Workspaces$Templates$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Containers$Workspaces$Templates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Containers$Workspaces$Templates$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/tagmanager/v2/{+path}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['path'], + pathParams: ['path'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * tagmanager.accounts.containers.workspaces.templates.list + * @desc Lists all GTM Templates of a GTM container workspace. + * @alias tagmanager.accounts.containers.workspaces.templates.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.pageToken Continuation token for fetching the next page of results. + * @param {string} params.parent GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_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$Accounts$Containers$Workspaces$Templates$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Accounts$Containers$Workspaces$Templates$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$Containers$Workspaces$Templates$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Accounts$Containers$Workspaces$Templates$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Containers$Workspaces$Templates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Containers$Workspaces$Templates$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/tagmanager/v2/{+parent}/templates').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * tagmanager.accounts.containers.workspaces.templates.revert + * @desc Reverts changes to a GTM Template in a GTM Workspace. + * @alias tagmanager.accounts.containers.workspaces.templates.revert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.fingerprint When provided, this fingerprint must match the fingerprint of the template in storage. + * @param {string} params.path GTM Custom Template's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/templates/{template_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 + */ + revert( + params?: Params$Resource$Accounts$Containers$Workspaces$Templates$Revert, + options?: MethodOptions + ): GaxiosPromise; + revert( + params: Params$Resource$Accounts$Containers$Workspaces$Templates$Revert, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + revert( + params: Params$Resource$Accounts$Containers$Workspaces$Templates$Revert, + callback: BodyResponseCallback + ): void; + revert(callback: BodyResponseCallback): void; + revert( + paramsOrCallback?: + | Params$Resource$Accounts$Containers$Workspaces$Templates$Revert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Containers$Workspaces$Templates$Revert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Containers$Workspaces$Templates$Revert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/tagmanager/v2/{+path}:revert').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['path'], + pathParams: ['path'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * tagmanager.accounts.containers.workspaces.templates.update + * @desc Updates a GTM Template. + * @alias tagmanager.accounts.containers.workspaces.templates.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.fingerprint When provided, this fingerprint must match the fingerprint of the templates in storage. + * @param {string} params.path GTM Custom Template's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/templates/{template_id} + * @param {().CustomTemplate} 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 + */ + update( + params?: Params$Resource$Accounts$Containers$Workspaces$Templates$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Accounts$Containers$Workspaces$Templates$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Accounts$Containers$Workspaces$Templates$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Accounts$Containers$Workspaces$Templates$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Containers$Workspaces$Templates$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Containers$Workspaces$Templates$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/tagmanager/v2/{+path}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['path'], + pathParams: ['path'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accounts$Containers$Workspaces$Templates$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CustomTemplate; + } + export interface Params$Resource$Accounts$Containers$Workspaces$Templates$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * GTM Custom Template's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/templates/{template_id} + */ + path?: string; + } + export interface Params$Resource$Accounts$Containers$Workspaces$Templates$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * GTM Custom Template's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/templates/{template_id} + */ + path?: string; + } + export interface Params$Resource$Accounts$Containers$Workspaces$Templates$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Continuation token for fetching the next page of results. + */ + pageToken?: string; + /** + * GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} + */ + parent?: string; + } + export interface Params$Resource$Accounts$Containers$Workspaces$Templates$Revert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * When provided, this fingerprint must match the fingerprint of the template in storage. + */ + fingerprint?: string; + /** + * GTM Custom Template's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/templates/{template_id} + */ + path?: string; + } + export interface Params$Resource$Accounts$Containers$Workspaces$Templates$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * When provided, this fingerprint must match the fingerprint of the templates in storage. + */ + fingerprint?: string; + /** + * GTM Custom Template's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/templates/{template_id} + */ + path?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CustomTemplate; + } + export class Resource$Accounts$Containers$Workspaces$Triggers { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/tagmanager/webpack.config.js b/src/apis/tagmanager/webpack.config.js index 159caf322e5..3a89aeba59a 100644 --- a/src/apis/tagmanager/webpack.config.js +++ b/src/apis/tagmanager/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/tasks/package.json b/src/apis/tasks/package.json index 0478f583a09..faa82fbff3b 100644 --- a/src/apis/tasks/package.json +++ b/src/apis/tasks/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/tasks/v1.ts b/src/apis/tasks/v1.ts index a442462b034..7caa7dbb612 100644 --- a/src/apis/tasks/v1.ts +++ b/src/apis/tasks/v1.ts @@ -113,7 +113,7 @@ export namespace tasks_v1 { */ deleted?: boolean; /** - * Due date of the task (as a RFC 3339 timestamp). Optional. + * Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn't possible to read or write the time that a task is due via the API. */ due?: string; /** diff --git a/src/apis/tasks/webpack.config.js b/src/apis/tasks/webpack.config.js index e295d4fdfa5..4516d8cd4b3 100644 --- a/src/apis/tasks/webpack.config.js +++ b/src/apis/tasks/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/testing/package.json b/src/apis/testing/package.json index 8f892290176..af31f7fda66 100644 --- a/src/apis/testing/package.json +++ b/src/apis/testing/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/testing/v1.ts b/src/apis/testing/v1.ts index 6e4689dc353..27d56df0511 100644 --- a/src/apis/testing/v1.ts +++ b/src/apis/testing/v1.ts @@ -523,11 +523,11 @@ export namespace testing_v1 { */ export interface Schema$DeviceFile { /** - * A reference to an opaque binary blob file + * A reference to an opaque binary blob file. */ obbFile?: Schema$ObbFile; /** - * A reference to a regular file + * A reference to a regular file. */ regularFile?: Schema$RegularFile; } @@ -606,7 +606,7 @@ export namespace testing_v1 { apkDetail?: Schema$ApkDetail; } /** - * Enables automatic Google account login. If set, the service will automatically generate a Google test account and add it to the device, before executing the test. Note that test accounts might be reused. Many applications show their full set of functionalities when an account is present on the device. Logging into the device with these generated accounts allows testing more functionalities. + * Enables automatic Google account login. If set, the service automatically generates a Google test account and adds it to the device, before executing the test. Note that test accounts might be reused. Many applications show their full set of functionalities when an account is present on the device. Logging into the device with these generated accounts allows testing more functionalities. */ export interface Schema$GoogleAuto {} /** @@ -729,7 +729,7 @@ export namespace testing_v1 { orientations?: Schema$Orientation[]; } /** - * A description of how to set up an iOS device prior to a test. + * A description of how to set up an iOS device prior to running the test. */ export interface Schema$IosTestSetup { /** @@ -885,6 +885,10 @@ export namespace testing_v1 { * Required. */ googleCloudStorage?: Schema$GoogleCloudStorage; + /** + * Output only. URL to the results in the Firebase Web Console. + */ + resultsUrl?: string; /** * Output only. The tool results execution that results are written to. */ @@ -915,7 +919,13 @@ export namespace testing_v1 { * Message for specifying the start activities to crawl. */ export interface Schema$RoboStartingIntent { + /** + * An intent that starts the main launcher activity. + */ launcherActivity?: Schema$LauncherActivityIntent; + /** + * An intent that starts an activity with specific details. + */ startActivity?: Schema$StartActivityIntent; /** * Timeout in seconds for each intent. @@ -974,7 +984,7 @@ export namespace testing_v1 { softwareCatalog?: Schema$ProvidedSoftwareCatalog; } /** - * Specifies a single test to be executed in a single environment. + * A single test executed in a single environment. */ export interface Schema$TestExecution { /** @@ -982,7 +992,7 @@ export namespace testing_v1 { */ environment?: Schema$Environment; /** - * Output only. Unique id set by the backend. + * Output only. Unique id set by the service. */ id?: string; /** @@ -1015,7 +1025,7 @@ export namespace testing_v1 { toolResultsStep?: Schema$ToolResultsStep; } /** - * A group of one or more TestExecutions, built by taking a product of values over a pre-defined set of axes. + * TestMatrix captures all details about a test. It contains the environment configuration, test specification, test executions and overall state and outcome. */ export interface Schema$TestMatrix { /** @@ -1023,7 +1033,7 @@ export namespace testing_v1 { */ clientInfo?: Schema$ClientInfo; /** - * Required. How the host machine(s) are configured. + * Required. The devices the tests are being executed on. */ environmentMatrix?: Schema$EnvironmentMatrix; /** @@ -1034,6 +1044,10 @@ export namespace testing_v1 { * Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state. */ invalidMatrixDetails?: string; + /** + * Output Only. The overall outcome of the test. Only set when the test matrix state is FINISHED. + */ + outcomeSummary?: string; /** * The cloud project that owns the test matrix. */ @@ -1043,7 +1057,7 @@ export namespace testing_v1 { */ resultStorage?: Schema$ResultStorage; /** - * Output only. Indicates the current progress of the test matrix (e.g., FINISHED). + * Output only. Indicates the current progress of the test matrix. */ state?: string; /** @@ -1109,11 +1123,11 @@ export namespace testing_v1 { */ androidTestLoop?: Schema$AndroidTestLoop; /** - * Disables performance metrics recording; may reduce test latency. + * Disables performance metrics recording. May reduce test latency. */ disablePerformanceMetrics?: boolean; /** - * Disables video recording; may reduce test latency. + * Disables video recording. May reduce test latency. */ disableVideoRecording?: boolean; /** diff --git a/src/apis/testing/webpack.config.js b/src/apis/testing/webpack.config.js index bd9bfed00e7..687ce369caf 100644 --- a/src/apis/testing/webpack.config.js +++ b/src/apis/testing/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/texttospeech/package.json b/src/apis/texttospeech/package.json index 8cd92b95b1f..71a0c568729 100644 --- a/src/apis/texttospeech/package.json +++ b/src/apis/texttospeech/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/texttospeech/v1.ts b/src/apis/texttospeech/v1.ts index 005f4276017..56d76533902 100644 --- a/src/apis/texttospeech/v1.ts +++ b/src/apis/texttospeech/v1.ts @@ -124,27 +124,27 @@ export namespace texttospeech_v1 { */ export interface Schema$AudioConfig { /** - * Required. The format of the requested audio byte stream. + * Required. The format of the 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. See [audio-profiles](https: //cloud.google.com/text-to-speech/docs/audio-profiles) for current supported profile ids. + * Optional. Input only. 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. See [audio profiles](https://cloud.google.com/text-to-speech/docs/audio-profiles) for current supported profile ids. */ 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 the original pitch. + * Optional. Input only. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. */ pitch?: number; /** - * The synthesis sample rate (in hertz) for this audio. Optional. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT. + * The synthesis sample rate (in hertz) for this audio. Optional. When this is specified in SynthesizeSpeechRequest, if this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT. */ sampleRateHertz?: number; /** - * Optional speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. + * Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. */ speakingRate?: number; /** - * Optional volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. Strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. + * Optional. Input only. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. Strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. */ volumeGainDb?: number; } @@ -192,7 +192,7 @@ export namespace texttospeech_v1 { */ export interface Schema$SynthesizeSpeechResponse { /** - * The audio data bytes encoded as specified in the request, including the header (For LINEAR16 audio, we include the WAV header). Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + * The audio data bytes encoded as specified in the request, including the header for encodings that are wrapped in containers (e.g. MP3, OGG_OPUS). For LINEAR16 audio, we include the WAV header. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ audioContent?: string; } diff --git a/src/apis/texttospeech/v1beta1.ts b/src/apis/texttospeech/v1beta1.ts index 9b4ebfd943c..08540efd02d 100644 --- a/src/apis/texttospeech/v1beta1.ts +++ b/src/apis/texttospeech/v1beta1.ts @@ -124,27 +124,27 @@ export namespace texttospeech_v1beta1 { */ export interface Schema$AudioConfig { /** - * Required. The format of the requested audio byte stream. + * Required. The format of the 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. See [audio-profiles](https: //cloud.google.com/text-to-speech/docs/audio-profiles) for current supported profile ids. + * Optional. Input only. 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. See [audio profiles](https://cloud.google.com/text-to-speech/docs/audio-profiles) for current supported profile ids. */ 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 the original pitch. + * Optional. Input only. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. */ pitch?: number; /** - * The synthesis sample rate (in hertz) for this audio. Optional. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT. + * The synthesis sample rate (in hertz) for this audio. Optional. When this is specified in SynthesizeSpeechRequest, if this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT. */ sampleRateHertz?: number; /** - * Optional speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. + * Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. */ speakingRate?: number; /** - * Optional volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. Strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. + * Optional. Input only. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. Strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. */ volumeGainDb?: number; } @@ -192,7 +192,7 @@ export namespace texttospeech_v1beta1 { */ export interface Schema$SynthesizeSpeechResponse { /** - * The audio data bytes encoded as specified in the request, including the header (For LINEAR16 audio, we include the WAV header). Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + * The audio data bytes encoded as specified in the request, including the header for encodings that are wrapped in containers (e.g. MP3, OGG_OPUS). For LINEAR16 audio, we include the WAV header. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ audioContent?: string; } diff --git a/src/apis/texttospeech/webpack.config.js b/src/apis/texttospeech/webpack.config.js index a527857355c..6950ee056fa 100644 --- a/src/apis/texttospeech/webpack.config.js +++ b/src/apis/texttospeech/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/toolresults/package.json b/src/apis/toolresults/package.json index 1a52d89f96e..723bc4adb52 100644 --- a/src/apis/toolresults/package.json +++ b/src/apis/toolresults/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/toolresults/v1beta3.ts b/src/apis/toolresults/v1beta3.ts index 4720e0f2d5b..ceb1a820b8d 100644 --- a/src/apis/toolresults/v1beta3.ts +++ b/src/apis/toolresults/v1beta3.ts @@ -435,6 +435,10 @@ export namespace toolresults_v1beta3 { * If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running. */ abortedByUser?: boolean; + /** + * If results are being provided to the user in certain cases of infrastructure failures + */ + hasErrorLogs?: boolean; /** * If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed. For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail. */ @@ -781,7 +785,7 @@ export namespace toolresults_v1beta3 { exception?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -984,6 +988,10 @@ export namespace toolresults_v1beta3 { * A summary of a test suite result either parsed from XML or uploaded directly by a user. Note: the API related comments are for StepService only. This message is also being used in ExecutionService in a read only mode for the corresponding step. */ export interface Schema$TestSuiteOverview { + /** + * Elapsed time of test suite. + */ + elapsedTime?: Schema$Duration; /** * Number of test cases in error, typically set by the service by parsing the xml_source. - In create/response: always set - In update request: never */ diff --git a/src/apis/toolresults/webpack.config.js b/src/apis/toolresults/webpack.config.js index f8f887030ce..9df373f37de 100644 --- a/src/apis/toolresults/webpack.config.js +++ b/src/apis/toolresults/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/tpu/package.json b/src/apis/tpu/package.json index c9dac88a541..99db1f2851a 100644 --- a/src/apis/tpu/package.json +++ b/src/apis/tpu/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/tpu/v1.ts b/src/apis/tpu/v1.ts index aa149f1905b..cfa8af93376 100644 --- a/src/apis/tpu/v1.ts +++ b/src/apis/tpu/v1.ts @@ -386,7 +386,7 @@ export namespace tpu_v1 { */ export interface Schema$StartNodeRequest {} /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/tpu/v1alpha1.ts b/src/apis/tpu/v1alpha1.ts index bc9b4df866f..0e35ef41968 100644 --- a/src/apis/tpu/v1alpha1.ts +++ b/src/apis/tpu/v1alpha1.ts @@ -386,7 +386,7 @@ export namespace tpu_v1alpha1 { */ export interface Schema$StartNodeRequest {} /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/tpu/webpack.config.js b/src/apis/tpu/webpack.config.js index 3e9a517bc8d..fbc0e4bc3b8 100644 --- a/src/apis/tpu/webpack.config.js +++ b/src/apis/tpu/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/translate/package.json b/src/apis/translate/package.json index 2814beb4207..adfbb605f37 100644 --- a/src/apis/translate/package.json +++ b/src/apis/translate/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/translate/webpack.config.js b/src/apis/translate/webpack.config.js index b2f3d94cec2..d504703bb86 100644 --- a/src/apis/translate/webpack.config.js +++ b/src/apis/translate/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/urlshortener/package.json b/src/apis/urlshortener/package.json index cfc1347f01e..3b97fe07ad9 100644 --- a/src/apis/urlshortener/package.json +++ b/src/apis/urlshortener/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/urlshortener/webpack.config.js b/src/apis/urlshortener/webpack.config.js index b1985bf5fd2..18d0c8ec19d 100644 --- a/src/apis/urlshortener/webpack.config.js +++ b/src/apis/urlshortener/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/vault/package.json b/src/apis/vault/package.json index 834fae61231..3658a6530c8 100644 --- a/src/apis/vault/package.json +++ b/src/apis/vault/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/vault/v1.ts b/src/apis/vault/v1.ts index f87b7708756..5e0e87ab8ae 100644 --- a/src/apis/vault/v1.ts +++ b/src/apis/vault/v1.ts @@ -255,6 +255,10 @@ export namespace vault_v1 { * Drive search advanced options */ export interface Schema$DriveOptions { + /** + * Set to true to include shared drive. + */ + includeSharedDrives?: boolean; /** * Set to true to include Team Drive. */ @@ -420,6 +424,10 @@ export namespace vault_v1 { * Query options for Drive holds. */ export interface Schema$HeldDriveQuery { + /** + * If true, include files in shared drives in the hold. + */ + includeSharedDriveFiles?: boolean; /** * If true, include files in Team Drives in the hold. */ @@ -680,6 +688,10 @@ export namespace vault_v1 { * For mail search, specify more options in this field. */ mailOptions?: Schema$MailOptions; + /** + * The search method to use. This field is similar to the search_method field but is introduced to support shared drives. It supports all search method types. In case the search_method is TEAM_DRIVE the response of this field will be SHARED_DRIVE only. + */ + method?: string; /** * When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified. */ @@ -688,6 +700,10 @@ export namespace vault_v1 { * The search method to use. */ searchMethod?: string; + /** + * When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs to be specified. + */ + sharedDriveInfo?: Schema$SharedDriveInfo; /** * The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. */ @@ -771,7 +787,16 @@ export namespace vault_v1 { savedQueryId?: string; } /** - * 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. + * Shared drives to search + */ + export interface Schema$SharedDriveInfo { + /** + * List of Shared drive ids, as provided by <a href="https://developers.google.com/drive">Drive API</a>. + */ + sharedDriveIds?: string[]; + } + /** + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/vault/webpack.config.js b/src/apis/vault/webpack.config.js index 7db1a3a2145..32d9276c455 100644 --- a/src/apis/vault/webpack.config.js +++ b/src/apis/vault/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/videointelligence/package.json b/src/apis/videointelligence/package.json index 0ce13337706..34b1828eea3 100644 --- a/src/apis/videointelligence/package.json +++ b/src/apis/videointelligence/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/videointelligence/v1.ts b/src/apis/videointelligence/v1.ts index 7b050886098..d92405e9098 100644 --- a/src/apis/videointelligence/v1.ts +++ b/src/apis/videointelligence/v1.ts @@ -106,6 +106,7 @@ export namespace videointelligence_v1 { export class Videointelligence { context: APIRequestContext; operations: Resource$Operations; + projects: Resource$Projects; videos: Resource$Videos; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -115,6 +116,7 @@ export namespace videointelligence_v1 { }; this.operations = new Resource$Operations(this.context); + this.projects = new Resource$Projects(this.context); this.videos = new Resource$Videos(this.context); } } @@ -309,7 +311,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -317,7 +319,7 @@ export namespace videointelligence_v1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1beta2_WordInfo[]; } @@ -381,6 +383,10 @@ export namespace videointelligence_v1 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -389,6 +395,10 @@ export namespace videointelligence_v1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** * Time when the request was received. */ @@ -423,7 +433,7 @@ export namespace videointelligence_v1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -431,7 +441,7 @@ export namespace videointelligence_v1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -671,7 +681,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -679,7 +689,7 @@ export namespace videointelligence_v1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo[]; } @@ -743,6 +753,10 @@ export namespace videointelligence_v1 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -751,6 +765,10 @@ export namespace videointelligence_v1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** * Time when the request was received. */ @@ -785,7 +803,7 @@ export namespace videointelligence_v1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -793,7 +811,7 @@ export namespace videointelligence_v1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1033,7 +1051,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1041,7 +1059,7 @@ export namespace videointelligence_v1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo[]; } @@ -1105,6 +1123,10 @@ export namespace videointelligence_v1 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -1113,6 +1135,10 @@ export namespace videointelligence_v1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** * Time when the request was received. */ @@ -1147,7 +1173,7 @@ export namespace videointelligence_v1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1155,7 +1181,7 @@ export namespace videointelligence_v1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1223,6 +1249,23 @@ export namespace videointelligence_v1 { */ annotationResults?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationResults[]; } + /** + * A generic detected attribute represented by name in string format. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute { + /** + * Detected attribute confidence. Range [0, 1]. + */ + confidence?: number; + /** + * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + */ + name?: string; + /** + * Text value of the detection result. For example, the value for "HairColor" can be "black", "blonde", etc. + */ + value?: string; + } /** * Detected entity from video analysis. */ @@ -1309,6 +1352,23 @@ export namespace videointelligence_v1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } + /** + * Annotation corresponding to one detected, tracked and recognized logo class. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LogoRecognitionAnnotation { + /** + * Entity category information to specify the logo class that all the logo tracks within this LogoRecognitionAnnotation are recognized as. + */ + entity?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity; + /** + * All video segments where the recognized logo appears. There might be multiple instances of the same logo class appearing in one VideoSegment. + */ + segments?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; + /** + * All logo tracks where the recognized logo appears. Each track corresponds to one logo instance appearing in consecutive frames. + */ + tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; + } /** * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ @@ -1395,7 +1455,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1403,7 +1463,7 @@ export namespace videointelligence_v1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p3beta1_WordInfo[]; } @@ -1501,10 +1561,52 @@ export namespace videointelligence_v1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } + /** + * For tracking related features, such as LOGO_RECOGNITION, FACE_DETECTION, CELEBRITY_RECOGNITION, PERSON_DETECTION. An object at time_offset with attributes, and located with normalized_bounding_box. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TimestampedObject { + /** + * Optional. The attributes of the object in the bounding box. + */ + attributes?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute[]; + /** + * Normalized Bounding box in a frame, where the object is located. + */ + normalizedBoundingBox?: Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedBoundingBox; + /** + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this object. + */ + timeOffset?: string; + } + /** + * A track of an object instance. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_Track { + /** + * Optional. Attributes in the track level. + */ + attributes?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute[]; + /** + * Optional. The confidence score of the tracked object. + */ + confidence?: number; + /** + * Video segment of a track. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; + /** + * The object with timestamp and attributes per frame in the track. + */ + timestampedObjects?: Schema$GoogleCloudVideointelligenceV1p3beta1_TimestampedObject[]; + } /** * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -1513,6 +1615,10 @@ export namespace videointelligence_v1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** * Time when the request was received. */ @@ -1542,12 +1648,16 @@ export namespace videointelligence_v1 { * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; + /** + * Annotations for list of logos detected, tracked and recognized in video. + */ + logoRecognitionAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LogoRecognitionAnnotation[]; /** * Annotations for list of objects detected and tracked in video. */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1555,7 +1665,7 @@ export namespace videointelligence_v1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1840,6 +1950,15 @@ export namespace videointelligence_v1 { */ trackId?: string; } + /** + * Config for OBJECT_TRACKING. + */ + export interface Schema$GoogleCloudVideointelligenceV1_ObjectTrackingConfig { + /** + * Model to use for object tracking. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". + */ + model?: string; + } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ @@ -1876,7 +1995,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1884,7 +2003,7 @@ export namespace videointelligence_v1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1_WordInfo[]; } @@ -1963,6 +2082,10 @@ export namespace videointelligence_v1 { * Language hint can be specified if the language to be detected is known a priori. It can increase the accuracy of the detection. Language hint must be language code in BCP-47 format. Automatic language detection is performed if no hint is provided. */ languageHints?: string[]; + /** + * Model to use for text detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". + */ + model?: string; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -1998,6 +2121,10 @@ export namespace videointelligence_v1 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -2006,6 +2133,10 @@ export namespace videointelligence_v1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** * Time when the request was received. */ @@ -2040,7 +2171,7 @@ export namespace videointelligence_v1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2048,7 +2179,7 @@ export namespace videointelligence_v1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2072,6 +2203,10 @@ export namespace videointelligence_v1 { * Config for LABEL_DETECTION. */ labelDetectionConfig?: Schema$GoogleCloudVideointelligenceV1_LabelDetectionConfig; + /** + * Config for OBJECT_TRACKING. + */ + objectTrackingConfig?: Schema$GoogleCloudVideointelligenceV1_ObjectTrackingConfig; /** * 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. */ @@ -2161,7 +2296,7 @@ export namespace videointelligence_v1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -2174,7 +2309,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleProtobuf_Empty {} /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$GoogleRpc_Status { /** @@ -2193,8 +2328,10 @@ export namespace videointelligence_v1 { export class Resource$Operations { context: APIRequestContext; + projects: Resource$Operations$Projects; constructor(context: APIRequestContext) { this.context = context; + this.projects = new Resource$Operations$Projects(this.context); } /** @@ -2205,7 +2342,6 @@ export namespace videointelligence_v1 { * * @param {object} params Parameters for request * @param {string} params.name The name of the operation resource to be cancelled. - * @param {().GoogleLongrunning_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 @@ -2432,63 +2568,114 @@ export namespace videointelligence_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Operations$Cancel + extends StandardParameters { /** - * videointelligence.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 videointelligence.operations.list + * 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; + } + export interface Params$Resource$Operations$Delete + extends StandardParameters { + /** + * 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 extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource. + */ + name?: string; + } + + export class Resource$Operations$Projects { + context: APIRequestContext; + locations: Resource$Operations$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Operations$Projects$Locations(this.context); + } + } + + export class Resource$Operations$Projects$Locations { + context: APIRequestContext; + operations: Resource$Operations$Projects$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Operations$Projects$Locations$Operations( + this.context + ); + } + } + + export class Resource$Operations$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * videointelligence.operations.projects.locations.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 videointelligence.operations.projects.locations.operations.cancel * @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 {string} params.name The name of the operation resource to be cancelled. * @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, + cancel( + params?: Params$Resource$Operations$Projects$Locations$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Operations$List, + ): GaxiosPromise; + cancel( + params: Params$Resource$Operations$Projects$Locations$Operations$Cancel, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$GoogleLongrunning_ListOperationsResponse - > - ): void; - list( - params: Params$Resource$Operations$List, - callback: BodyResponseCallback< - Schema$GoogleLongrunning_ListOperationsResponse - > + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback< - Schema$GoogleLongrunning_ListOperationsResponse - > + cancel( + params: Params$Resource$Operations$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback ): void; - list( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Operations$List - | BodyResponseCallback, + | Params$Resource$Operations$Projects$Locations$Operations$Cancel + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$GoogleLongrunning_ListOperationsResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Operations$List; + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Operations$Projects$Locations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Operations$List; + params = {} as Params$Resource$Operations$Projects$Locations$Operations$Cancel; options = {}; } @@ -2502,48 +2689,200 @@ export namespace videointelligence_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/operations').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/operations/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest< - Schema$GoogleLongrunning_ListOperationsResponse - >(parameters); + return createAPIRequest(parameters); } } - } - export interface Params$Resource$Operations$Cancel - extends StandardParameters { /** - * Auth client or API Key for the request + * videointelligence.operations.projects.locations.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 videointelligence.operations.projects.locations.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 */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + delete( + params?: Params$Resource$Operations$Projects$Locations$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Operations$Projects$Locations$Operations$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Operations$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Operations$Projects$Locations$Operations$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Operations$Projects$Locations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * The name of the operation resource to be cancelled. - */ - name?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Projects$Locations$Operations$Delete; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$GoogleLongrunning_CancelOperationRequest; - } - export interface Params$Resource$Operations$Delete - extends StandardParameters { + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://videointelligence.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/operations/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * videointelligence.operations.projects.locations.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 videointelligence.operations.projects.locations.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$Projects$Locations$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Operations$Projects$Locations$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Operations$Projects$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Operations$Projects$Locations$Operations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Operations$Projects$Locations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Projects$Locations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://videointelligence.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/operations/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Operations$Projects$Locations$Operations$Cancel + extends StandardParameters { + /** + * 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; + } + export interface Params$Resource$Operations$Projects$Locations$Operations$Delete + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2554,7 +2893,8 @@ export namespace videointelligence_v1 { */ name?: string; } - export interface Params$Resource$Operations$Get extends StandardParameters { + export interface Params$Resource$Operations$Projects$Locations$Operations$Get + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2565,7 +2905,400 @@ export namespace videointelligence_v1 { */ name?: string; } - export interface Params$Resource$Operations$List extends StandardParameters { + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + operations: Resource$Projects$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * videointelligence.projects.locations.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 videointelligence.projects.locations.operations.cancel + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be cancelled. + * @param {().GoogleLongrunning_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$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://videointelligence.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.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * videointelligence.projects.locations.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 videointelligence.projects.locations.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$Projects$Locations$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://videointelligence.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * videointelligence.projects.locations.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 videointelligence.projects.locations.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$Projects$Locations$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://videointelligence.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * videointelligence.projects.locations.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 videointelligence.projects.locations.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$Projects$Locations$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GoogleLongrunning_ListOperationsResponse + > + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback< + Schema$GoogleLongrunning_ListOperationsResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$GoogleLongrunning_ListOperationsResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GoogleLongrunning_ListOperationsResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://videointelligence.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$GoogleLongrunning_ListOperationsResponse + >(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { + /** + * 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$GoogleLongrunning_CancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Operations$Delete + extends StandardParameters { + /** + * 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$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * 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$Projects$Locations$Operations$List + extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/videointelligence/v1beta2.ts b/src/apis/videointelligence/v1beta2.ts index 6b600d802cf..30b621521c4 100644 --- a/src/apis/videointelligence/v1beta2.ts +++ b/src/apis/videointelligence/v1beta2.ts @@ -352,6 +352,15 @@ export namespace videointelligence_v1beta2 { */ trackId?: string; } + /** + * Config for OBJECT_TRACKING. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingConfig { + /** + * Model to use for object tracking. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". + */ + model?: string; + } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ @@ -388,7 +397,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -396,7 +405,7 @@ export namespace videointelligence_v1beta2 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1beta2_WordInfo[]; } @@ -475,6 +484,10 @@ export namespace videointelligence_v1beta2 { * Language hint can be specified if the language to be detected is known a priori. It can increase the accuracy of the detection. Language hint must be language code in BCP-47 format. Automatic language detection is performed if no hint is provided. */ languageHints?: string[]; + /** + * Model to use for text detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". + */ + model?: string; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -510,6 +523,10 @@ export namespace videointelligence_v1beta2 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -518,6 +535,10 @@ export namespace videointelligence_v1beta2 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** * Time when the request was received. */ @@ -552,7 +573,7 @@ export namespace videointelligence_v1beta2 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -560,7 +581,7 @@ export namespace videointelligence_v1beta2 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -584,6 +605,10 @@ export namespace videointelligence_v1beta2 { * Config for LABEL_DETECTION. */ labelDetectionConfig?: Schema$GoogleCloudVideointelligenceV1beta2_LabelDetectionConfig; + /** + * Config for OBJECT_TRACKING. + */ + objectTrackingConfig?: Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingConfig; /** * 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. */ @@ -829,7 +854,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -837,7 +862,7 @@ export namespace videointelligence_v1beta2 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo[]; } @@ -901,6 +926,10 @@ export namespace videointelligence_v1beta2 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -909,6 +938,10 @@ export namespace videointelligence_v1beta2 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** * Time when the request was received. */ @@ -943,7 +976,7 @@ export namespace videointelligence_v1beta2 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -951,7 +984,7 @@ export namespace videointelligence_v1beta2 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1191,7 +1224,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1199,7 +1232,7 @@ export namespace videointelligence_v1beta2 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo[]; } @@ -1263,6 +1296,10 @@ export namespace videointelligence_v1beta2 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -1271,6 +1308,10 @@ export namespace videointelligence_v1beta2 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** * Time when the request was received. */ @@ -1305,7 +1346,7 @@ export namespace videointelligence_v1beta2 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1313,7 +1354,7 @@ export namespace videointelligence_v1beta2 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1381,6 +1422,23 @@ export namespace videointelligence_v1beta2 { */ annotationResults?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationResults[]; } + /** + * A generic detected attribute represented by name in string format. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute { + /** + * Detected attribute confidence. Range [0, 1]. + */ + confidence?: number; + /** + * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + */ + name?: string; + /** + * Text value of the detection result. For example, the value for "HairColor" can be "black", "blonde", etc. + */ + value?: string; + } /** * Detected entity from video analysis. */ @@ -1467,6 +1525,23 @@ export namespace videointelligence_v1beta2 { */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } + /** + * Annotation corresponding to one detected, tracked and recognized logo class. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LogoRecognitionAnnotation { + /** + * Entity category information to specify the logo class that all the logo tracks within this LogoRecognitionAnnotation are recognized as. + */ + entity?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity; + /** + * All video segments where the recognized logo appears. There might be multiple instances of the same logo class appearing in one VideoSegment. + */ + segments?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; + /** + * All logo tracks where the recognized logo appears. Each track corresponds to one logo instance appearing in consecutive frames. + */ + tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; + } /** * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ @@ -1553,7 +1628,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1561,7 +1636,7 @@ export namespace videointelligence_v1beta2 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p3beta1_WordInfo[]; } @@ -1659,10 +1734,52 @@ export namespace videointelligence_v1beta2 { */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } + /** + * For tracking related features, such as LOGO_RECOGNITION, FACE_DETECTION, CELEBRITY_RECOGNITION, PERSON_DETECTION. An object at time_offset with attributes, and located with normalized_bounding_box. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TimestampedObject { + /** + * Optional. The attributes of the object in the bounding box. + */ + attributes?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute[]; + /** + * Normalized Bounding box in a frame, where the object is located. + */ + normalizedBoundingBox?: Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedBoundingBox; + /** + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this object. + */ + timeOffset?: string; + } + /** + * A track of an object instance. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_Track { + /** + * Optional. Attributes in the track level. + */ + attributes?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute[]; + /** + * Optional. The confidence score of the tracked object. + */ + confidence?: number; + /** + * Video segment of a track. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; + /** + * The object with timestamp and attributes per frame in the track. + */ + timestampedObjects?: Schema$GoogleCloudVideointelligenceV1p3beta1_TimestampedObject[]; + } /** * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -1671,6 +1788,10 @@ export namespace videointelligence_v1beta2 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** * Time when the request was received. */ @@ -1700,12 +1821,16 @@ export namespace videointelligence_v1beta2 { * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; + /** + * Annotations for list of logos detected, tracked and recognized in video. + */ + logoRecognitionAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LogoRecognitionAnnotation[]; /** * Annotations for list of objects detected and tracked in video. */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1713,7 +1838,7 @@ export namespace videointelligence_v1beta2 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1953,7 +2078,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1961,7 +2086,7 @@ export namespace videointelligence_v1beta2 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1_WordInfo[]; } @@ -2025,6 +2150,10 @@ export namespace videointelligence_v1beta2 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -2033,6 +2162,10 @@ export namespace videointelligence_v1beta2 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** * Time when the request was received. */ @@ -2067,7 +2200,7 @@ export namespace videointelligence_v1beta2 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2075,7 +2208,7 @@ export namespace videointelligence_v1beta2 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2142,7 +2275,7 @@ export namespace videointelligence_v1beta2 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -2151,7 +2284,7 @@ export namespace videointelligence_v1beta2 { response?: {[key: string]: 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$GoogleRpc_Status { /** diff --git a/src/apis/videointelligence/v1p1beta1.ts b/src/apis/videointelligence/v1p1beta1.ts index 83402fd268e..117b71f9479 100644 --- a/src/apis/videointelligence/v1p1beta1.ts +++ b/src/apis/videointelligence/v1p1beta1.ts @@ -307,7 +307,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -315,7 +315,7 @@ export namespace videointelligence_v1p1beta1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1beta2_WordInfo[]; } @@ -379,6 +379,10 @@ export namespace videointelligence_v1p1beta1 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -387,6 +391,10 @@ export namespace videointelligence_v1p1beta1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** * Time when the request was received. */ @@ -421,7 +429,7 @@ export namespace videointelligence_v1p1beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -429,7 +437,7 @@ export namespace videointelligence_v1p1beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -714,6 +722,15 @@ export namespace videointelligence_v1p1beta1 { */ trackId?: string; } + /** + * Config for OBJECT_TRACKING. + */ + export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingConfig { + /** + * Model to use for object tracking. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". + */ + model?: string; + } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ @@ -750,7 +767,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -758,7 +775,7 @@ export namespace videointelligence_v1p1beta1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo[]; } @@ -837,6 +854,10 @@ export namespace videointelligence_v1p1beta1 { * Language hint can be specified if the language to be detected is known a priori. It can increase the accuracy of the detection. Language hint must be language code in BCP-47 format. Automatic language detection is performed if no hint is provided. */ languageHints?: string[]; + /** + * Model to use for text detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". + */ + model?: string; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -872,6 +893,10 @@ export namespace videointelligence_v1p1beta1 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -880,6 +905,10 @@ export namespace videointelligence_v1p1beta1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** * Time when the request was received. */ @@ -914,7 +943,7 @@ export namespace videointelligence_v1p1beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -922,7 +951,7 @@ export namespace videointelligence_v1p1beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -946,6 +975,10 @@ export namespace videointelligence_v1p1beta1 { * Config for LABEL_DETECTION. */ labelDetectionConfig?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelDetectionConfig; + /** + * Config for OBJECT_TRACKING. + */ + objectTrackingConfig?: Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingConfig; /** * 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. */ @@ -1191,7 +1224,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1199,7 +1232,7 @@ export namespace videointelligence_v1p1beta1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo[]; } @@ -1263,6 +1296,10 @@ export namespace videointelligence_v1p1beta1 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -1271,6 +1308,10 @@ export namespace videointelligence_v1p1beta1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** * Time when the request was received. */ @@ -1305,7 +1346,7 @@ export namespace videointelligence_v1p1beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1313,7 +1354,7 @@ export namespace videointelligence_v1p1beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1381,6 +1422,23 @@ export namespace videointelligence_v1p1beta1 { */ annotationResults?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationResults[]; } + /** + * A generic detected attribute represented by name in string format. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute { + /** + * Detected attribute confidence. Range [0, 1]. + */ + confidence?: number; + /** + * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + */ + name?: string; + /** + * Text value of the detection result. For example, the value for "HairColor" can be "black", "blonde", etc. + */ + value?: string; + } /** * Detected entity from video analysis. */ @@ -1467,6 +1525,23 @@ export namespace videointelligence_v1p1beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } + /** + * Annotation corresponding to one detected, tracked and recognized logo class. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LogoRecognitionAnnotation { + /** + * Entity category information to specify the logo class that all the logo tracks within this LogoRecognitionAnnotation are recognized as. + */ + entity?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity; + /** + * All video segments where the recognized logo appears. There might be multiple instances of the same logo class appearing in one VideoSegment. + */ + segments?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; + /** + * All logo tracks where the recognized logo appears. Each track corresponds to one logo instance appearing in consecutive frames. + */ + tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; + } /** * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ @@ -1553,7 +1628,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1561,7 +1636,7 @@ export namespace videointelligence_v1p1beta1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p3beta1_WordInfo[]; } @@ -1659,10 +1734,52 @@ export namespace videointelligence_v1p1beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } + /** + * For tracking related features, such as LOGO_RECOGNITION, FACE_DETECTION, CELEBRITY_RECOGNITION, PERSON_DETECTION. An object at time_offset with attributes, and located with normalized_bounding_box. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TimestampedObject { + /** + * Optional. The attributes of the object in the bounding box. + */ + attributes?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute[]; + /** + * Normalized Bounding box in a frame, where the object is located. + */ + normalizedBoundingBox?: Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedBoundingBox; + /** + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this object. + */ + timeOffset?: string; + } + /** + * A track of an object instance. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_Track { + /** + * Optional. Attributes in the track level. + */ + attributes?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute[]; + /** + * Optional. The confidence score of the tracked object. + */ + confidence?: number; + /** + * Video segment of a track. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; + /** + * The object with timestamp and attributes per frame in the track. + */ + timestampedObjects?: Schema$GoogleCloudVideointelligenceV1p3beta1_TimestampedObject[]; + } /** * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -1671,6 +1788,10 @@ export namespace videointelligence_v1p1beta1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** * Time when the request was received. */ @@ -1700,12 +1821,16 @@ export namespace videointelligence_v1p1beta1 { * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; + /** + * Annotations for list of logos detected, tracked and recognized in video. + */ + logoRecognitionAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LogoRecognitionAnnotation[]; /** * Annotations for list of objects detected and tracked in video. */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1713,7 +1838,7 @@ export namespace videointelligence_v1p1beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1953,7 +2078,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1961,7 +2086,7 @@ export namespace videointelligence_v1p1beta1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1_WordInfo[]; } @@ -2025,6 +2150,10 @@ export namespace videointelligence_v1p1beta1 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -2033,6 +2162,10 @@ export namespace videointelligence_v1p1beta1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** * Time when the request was received. */ @@ -2067,7 +2200,7 @@ export namespace videointelligence_v1p1beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2075,7 +2208,7 @@ export namespace videointelligence_v1p1beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2142,7 +2275,7 @@ export namespace videointelligence_v1p1beta1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -2151,7 +2284,7 @@ export namespace videointelligence_v1p1beta1 { response?: {[key: string]: 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$GoogleRpc_Status { /** diff --git a/src/apis/videointelligence/v1p2beta1.ts b/src/apis/videointelligence/v1p2beta1.ts index bf66eb08e40..b42b75afe88 100644 --- a/src/apis/videointelligence/v1p2beta1.ts +++ b/src/apis/videointelligence/v1p2beta1.ts @@ -307,7 +307,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -315,7 +315,7 @@ export namespace videointelligence_v1p2beta1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1beta2_WordInfo[]; } @@ -379,6 +379,10 @@ export namespace videointelligence_v1p2beta1 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -387,6 +391,10 @@ export namespace videointelligence_v1p2beta1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** * Time when the request was received. */ @@ -421,7 +429,7 @@ export namespace videointelligence_v1p2beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -429,7 +437,7 @@ export namespace videointelligence_v1p2beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -669,7 +677,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -677,7 +685,7 @@ export namespace videointelligence_v1p2beta1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo[]; } @@ -741,6 +749,10 @@ export namespace videointelligence_v1p2beta1 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -749,6 +761,10 @@ export namespace videointelligence_v1p2beta1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** * Time when the request was received. */ @@ -783,7 +799,7 @@ export namespace videointelligence_v1p2beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -791,7 +807,7 @@ export namespace videointelligence_v1p2beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1076,6 +1092,15 @@ export namespace videointelligence_v1p2beta1 { */ trackId?: string; } + /** + * Config for OBJECT_TRACKING. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingConfig { + /** + * Model to use for object tracking. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". + */ + model?: string; + } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ @@ -1112,7 +1137,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1120,7 +1145,7 @@ export namespace videointelligence_v1p2beta1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo[]; } @@ -1199,6 +1224,10 @@ export namespace videointelligence_v1p2beta1 { * Language hint can be specified if the language to be detected is known a priori. It can increase the accuracy of the detection. Language hint must be language code in BCP-47 format. Automatic language detection is performed if no hint is provided. */ languageHints?: string[]; + /** + * Model to use for text detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". + */ + model?: string; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -1234,6 +1263,10 @@ export namespace videointelligence_v1p2beta1 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -1242,6 +1275,10 @@ export namespace videointelligence_v1p2beta1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** * Time when the request was received. */ @@ -1276,7 +1313,7 @@ export namespace videointelligence_v1p2beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1284,7 +1321,7 @@ export namespace videointelligence_v1p2beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1308,6 +1345,10 @@ export namespace videointelligence_v1p2beta1 { * Config for LABEL_DETECTION. */ labelDetectionConfig?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelDetectionConfig; + /** + * Config for OBJECT_TRACKING. + */ + objectTrackingConfig?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingConfig; /** * 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. */ @@ -1381,6 +1422,23 @@ export namespace videointelligence_v1p2beta1 { */ annotationResults?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationResults[]; } + /** + * A generic detected attribute represented by name in string format. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute { + /** + * Detected attribute confidence. Range [0, 1]. + */ + confidence?: number; + /** + * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + */ + name?: string; + /** + * Text value of the detection result. For example, the value for "HairColor" can be "black", "blonde", etc. + */ + value?: string; + } /** * Detected entity from video analysis. */ @@ -1467,6 +1525,23 @@ export namespace videointelligence_v1p2beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } + /** + * Annotation corresponding to one detected, tracked and recognized logo class. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LogoRecognitionAnnotation { + /** + * Entity category information to specify the logo class that all the logo tracks within this LogoRecognitionAnnotation are recognized as. + */ + entity?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity; + /** + * All video segments where the recognized logo appears. There might be multiple instances of the same logo class appearing in one VideoSegment. + */ + segments?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; + /** + * All logo tracks where the recognized logo appears. Each track corresponds to one logo instance appearing in consecutive frames. + */ + tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; + } /** * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ @@ -1553,7 +1628,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1561,7 +1636,7 @@ export namespace videointelligence_v1p2beta1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p3beta1_WordInfo[]; } @@ -1659,10 +1734,52 @@ export namespace videointelligence_v1p2beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } + /** + * For tracking related features, such as LOGO_RECOGNITION, FACE_DETECTION, CELEBRITY_RECOGNITION, PERSON_DETECTION. An object at time_offset with attributes, and located with normalized_bounding_box. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TimestampedObject { + /** + * Optional. The attributes of the object in the bounding box. + */ + attributes?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute[]; + /** + * Normalized Bounding box in a frame, where the object is located. + */ + normalizedBoundingBox?: Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedBoundingBox; + /** + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this object. + */ + timeOffset?: string; + } + /** + * A track of an object instance. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_Track { + /** + * Optional. Attributes in the track level. + */ + attributes?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute[]; + /** + * Optional. The confidence score of the tracked object. + */ + confidence?: number; + /** + * Video segment of a track. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; + /** + * The object with timestamp and attributes per frame in the track. + */ + timestampedObjects?: Schema$GoogleCloudVideointelligenceV1p3beta1_TimestampedObject[]; + } /** * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -1671,6 +1788,10 @@ export namespace videointelligence_v1p2beta1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** * Time when the request was received. */ @@ -1700,12 +1821,16 @@ export namespace videointelligence_v1p2beta1 { * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; + /** + * Annotations for list of logos detected, tracked and recognized in video. + */ + logoRecognitionAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LogoRecognitionAnnotation[]; /** * Annotations for list of objects detected and tracked in video. */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1713,7 +1838,7 @@ export namespace videointelligence_v1p2beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1953,7 +2078,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1961,7 +2086,7 @@ export namespace videointelligence_v1p2beta1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1_WordInfo[]; } @@ -2025,6 +2150,10 @@ export namespace videointelligence_v1p2beta1 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -2033,6 +2162,10 @@ export namespace videointelligence_v1p2beta1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** * Time when the request was received. */ @@ -2067,7 +2200,7 @@ export namespace videointelligence_v1p2beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2075,7 +2208,7 @@ export namespace videointelligence_v1p2beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2142,7 +2275,7 @@ export namespace videointelligence_v1p2beta1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -2151,7 +2284,7 @@ export namespace videointelligence_v1p2beta1 { response?: {[key: string]: 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$GoogleRpc_Status { /** diff --git a/src/apis/videointelligence/v1p3beta1.ts b/src/apis/videointelligence/v1p3beta1.ts index 851f36f3019..3d747b23f5c 100644 --- a/src/apis/videointelligence/v1p3beta1.ts +++ b/src/apis/videointelligence/v1p3beta1.ts @@ -307,7 +307,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -315,7 +315,7 @@ export namespace videointelligence_v1p3beta1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1beta2_WordInfo[]; } @@ -379,6 +379,10 @@ export namespace videointelligence_v1p3beta1 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -387,6 +391,10 @@ export namespace videointelligence_v1p3beta1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** * Time when the request was received. */ @@ -421,7 +429,7 @@ export namespace videointelligence_v1p3beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -429,7 +437,7 @@ export namespace videointelligence_v1p3beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -669,7 +677,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -677,7 +685,7 @@ export namespace videointelligence_v1p3beta1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo[]; } @@ -741,6 +749,10 @@ export namespace videointelligence_v1p3beta1 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -749,6 +761,10 @@ export namespace videointelligence_v1p3beta1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** * Time when the request was received. */ @@ -783,7 +799,7 @@ export namespace videointelligence_v1p3beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -791,7 +807,7 @@ export namespace videointelligence_v1p3beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1031,7 +1047,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1039,7 +1055,7 @@ export namespace videointelligence_v1p3beta1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo[]; } @@ -1103,6 +1119,10 @@ export namespace videointelligence_v1p3beta1 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -1111,6 +1131,10 @@ export namespace videointelligence_v1p3beta1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** * Time when the request was received. */ @@ -1145,7 +1169,7 @@ export namespace videointelligence_v1p3beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1153,7 +1177,7 @@ export namespace videointelligence_v1p3beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1250,6 +1274,23 @@ export namespace videointelligence_v1p3beta1 { */ annotationResults?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationResults[]; } + /** + * A generic detected attribute represented by name in string format. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute { + /** + * Detected attribute confidence. Range [0, 1]. + */ + confidence?: number; + /** + * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + */ + name?: string; + /** + * Text value of the detection result. For example, the value for "HairColor" can be "black", "blonde", etc. + */ + value?: string; + } /** * Detected entity from video analysis. */ @@ -1370,6 +1411,23 @@ export namespace videointelligence_v1p3beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } + /** + * Annotation corresponding to one detected, tracked and recognized logo class. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LogoRecognitionAnnotation { + /** + * Entity category information to specify the logo class that all the logo tracks within this LogoRecognitionAnnotation are recognized as. + */ + entity?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity; + /** + * All video segments where the recognized logo appears. There might be multiple instances of the same logo class appearing in one VideoSegment. + */ + segments?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; + /** + * All logo tracks where the recognized logo appears. Each track corresponds to one logo instance appearing in consecutive frames. + */ + tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; + } /** * Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1]. */ @@ -1438,6 +1496,15 @@ export namespace videointelligence_v1p3beta1 { */ trackId?: string; } + /** + * Config for OBJECT_TRACKING. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingConfig { + /** + * Model to use for object tracking. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". + */ + model?: string; + } /** * Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence. */ @@ -1474,7 +1541,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1482,7 +1549,7 @@ export namespace videointelligence_v1p3beta1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p3beta1_WordInfo[]; } @@ -1599,6 +1666,10 @@ export namespace videointelligence_v1p3beta1 { * Language hint can be specified if the language to be detected is known a priori. It can increase the accuracy of the detection. Language hint must be language code in BCP-47 format. Automatic language detection is performed if no hint is provided. */ languageHints?: string[]; + /** + * Model to use for text detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". + */ + model?: string; } /** * Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets. @@ -1630,10 +1701,52 @@ export namespace videointelligence_v1p3beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } + /** + * For tracking related features, such as LOGO_RECOGNITION, FACE_DETECTION, CELEBRITY_RECOGNITION, PERSON_DETECTION. An object at time_offset with attributes, and located with normalized_bounding_box. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TimestampedObject { + /** + * Optional. The attributes of the object in the bounding box. + */ + attributes?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute[]; + /** + * Normalized Bounding box in a frame, where the object is located. + */ + normalizedBoundingBox?: Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedBoundingBox; + /** + * Time-offset, relative to the beginning of the video, corresponding to the video frame for this object. + */ + timeOffset?: string; + } + /** + * A track of an object instance. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_Track { + /** + * Optional. Attributes in the track level. + */ + attributes?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute[]; + /** + * Optional. The confidence score of the tracked object. + */ + confidence?: number; + /** + * Video segment of a track. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; + /** + * The object with timestamp and attributes per frame in the track. + */ + timestampedObjects?: Schema$GoogleCloudVideointelligenceV1p3beta1_TimestampedObject[]; + } /** * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -1642,6 +1755,10 @@ export namespace videointelligence_v1p3beta1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** * Time when the request was received. */ @@ -1671,12 +1788,16 @@ export namespace videointelligence_v1p3beta1 { * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ inputUri?: string; + /** + * Annotations for list of logos detected, tracked and recognized in video. + */ + logoRecognitionAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LogoRecognitionAnnotation[]; /** * Annotations for list of objects detected and tracked in video. */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1684,7 +1805,7 @@ export namespace videointelligence_v1p3beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1708,6 +1829,10 @@ export namespace videointelligence_v1p3beta1 { * Config for LABEL_DETECTION. */ labelDetectionConfig?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelDetectionConfig; + /** + * Config for OBJECT_TRACKING. + */ + objectTrackingConfig?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingConfig; /** * 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. */ @@ -1953,7 +2078,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative { /** - * 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. + * 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 set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** @@ -1961,7 +2086,7 @@ export namespace videointelligence_v1p3beta1 { */ transcript?: string; /** - * A list of word-specific information for each recognized word. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1_WordInfo[]; } @@ -2025,6 +2150,10 @@ export namespace videointelligence_v1p3beta1 { * Annotation progress for a single video. */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { + /** + * Specifies which feature is being tracked if the request contains more than one features. + */ + feature?: string; /** * Video file location in [Google Cloud Storage](https://cloud.google.com/storage/). */ @@ -2033,6 +2162,10 @@ export namespace videointelligence_v1p3beta1 { * Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. */ progressPercent?: number; + /** + * Specifies which segment is being tracked if the request contains more than one segments. + */ + segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** * Time when the request was received. */ @@ -2067,7 +2200,7 @@ export namespace videointelligence_v1p3beta1 { */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1_ObjectTrackingAnnotation[]; /** - * Label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2075,7 +2208,7 @@ export namespace videointelligence_v1p3beta1 { */ shotAnnotations?: Schema$GoogleCloudVideointelligenceV1_VideoSegment[]; /** - * Label annotations on shot level. There is exactly one element for each unique label. + * Topical label annotations on shot level. There is exactly one element for each unique label. */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2142,7 +2275,7 @@ export namespace videointelligence_v1p3beta1 { */ metadata?: {[key: string]: 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`. + * 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 be a resource name ending with `operations/{unique_id}`. */ name?: string; /** @@ -2151,7 +2284,7 @@ export namespace videointelligence_v1p3beta1 { response?: {[key: string]: 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$GoogleRpc_Status { /** diff --git a/src/apis/videointelligence/webpack.config.js b/src/apis/videointelligence/webpack.config.js index b3be8815c7c..4141aabfb49 100644 --- a/src/apis/videointelligence/webpack.config.js +++ b/src/apis/videointelligence/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/vision/package.json b/src/apis/vision/package.json index 4839d07f6c8..4359ae151bf 100644 --- a/src/apis/vision/package.json +++ b/src/apis/vision/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/vision/v1.ts b/src/apis/vision/v1.ts index 573437adece..b512e3998d5 100644 --- a/src/apis/vision/v1.ts +++ b/src/apis/vision/v1.ts @@ -1026,7 +1026,7 @@ export namespace vision_v1 { */ gcsSource?: Schema$GoogleCloudVisionV1p1beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -1187,7 +1187,7 @@ export namespace vision_v1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -1859,7 +1859,7 @@ export namespace vision_v1 { */ gcsSource?: Schema$GoogleCloudVisionV1p2beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -2020,7 +2020,7 @@ export namespace vision_v1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -2722,7 +2722,7 @@ export namespace vision_v1 { */ gcsSource?: Schema$GoogleCloudVisionV1p3beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -2883,7 +2883,7 @@ export namespace vision_v1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -3620,7 +3620,7 @@ export namespace vision_v1 { */ gcsSource?: Schema$GoogleCloudVisionV1p4beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -3781,7 +3781,7 @@ export namespace vision_v1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -4530,7 +4530,7 @@ export namespace vision_v1 { */ gcsSource?: Schema$GoogleCloudVisionV1p5beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -4724,7 +4724,7 @@ export namespace vision_v1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -5102,6 +5102,945 @@ export namespace vision_v1 { */ symbols?: Schema$GoogleCloudVisionV1p5beta1Symbol[]; } + /** + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. + */ + export interface Schema$GoogleCloudVisionV1p6beta1AnnotateFileResponse { + /** + * Information about the file for which this response is generated. + */ + inputConfig?: Schema$GoogleCloudVisionV1p6beta1InputConfig; + /** + * Individual responses to images found within the file. + */ + responses?: Schema$GoogleCloudVisionV1p6beta1AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; + } + /** + * Response to an image annotation request. + */ + export interface Schema$GoogleCloudVisionV1p6beta1AnnotateImageResponse { + /** + * If present, contextual information is needed to understand where this image comes from. + */ + context?: Schema$GoogleCloudVisionV1p6beta1ImageAnnotationContext; + /** + * If present, crop hints have completed successfully. + */ + cropHintsAnnotation?: Schema$GoogleCloudVisionV1p6beta1CropHintsAnnotation; + /** + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. + */ + error?: Schema$Status; + /** + * If present, face detection has completed successfully. + */ + faceAnnotations?: Schema$GoogleCloudVisionV1p6beta1FaceAnnotation[]; + /** + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. + */ + fullTextAnnotation?: Schema$GoogleCloudVisionV1p6beta1TextAnnotation; + /** + * If present, image properties were extracted successfully. + */ + imagePropertiesAnnotation?: Schema$GoogleCloudVisionV1p6beta1ImageProperties; + /** + * If present, image quality calculation has completed successfully. + */ + imageQualityAnnotation?: Schema$GoogleCloudVisionV1p6beta1ImageQuality; + /** + * If present, label detection has completed successfully. + */ + labelAnnotations?: Schema$GoogleCloudVisionV1p6beta1EntityAnnotation[]; + /** + * If present, landmark detection has completed successfully. + */ + landmarkAnnotations?: Schema$GoogleCloudVisionV1p6beta1EntityAnnotation[]; + /** + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. + */ + localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p6beta1LocalizedObjectAnnotation[]; + /** + * If present, logo detection has completed successfully. + */ + logoAnnotations?: Schema$GoogleCloudVisionV1p6beta1EntityAnnotation[]; + /** + * If present, objects attributes calculation has completed successfully. The attributes value will be filled in the EntityAnnotation.properties. Example: object_attribute_annotations { properties { name: "color" value: "blue" confidence: 0.1 } properties { name: "color" value: "white" confidence: 0.2 } properties { name: "material" value: "silk" confidence: 0.3 } } + */ + objectAttributeAnnotations?: Schema$GoogleCloudVisionV1p6beta1EntityAnnotation[]; + /** + * If present, product search has completed successfully. + */ + productSearchResults?: Schema$GoogleCloudVisionV1p6beta1ProductSearchResults; + /** + * If present, image quality optimization has completed successfully. + */ + qualityOptimizationResult?: Schema$GoogleCloudVisionV1p6beta1QualityOptimizationResult; + /** + * If present, safe-search annotation has completed successfully. + */ + safeSearchAnnotation?: Schema$GoogleCloudVisionV1p6beta1SafeSearchAnnotation; + /** + * If present, text (OCR) detection has completed successfully. + */ + textAnnotations?: Schema$GoogleCloudVisionV1p6beta1EntityAnnotation[]; + /** + * If present, web detection has completed successfully. + */ + webDetection?: Schema$GoogleCloudVisionV1p6beta1WebDetection; + } + /** + * The response for a single offline file annotation request. + */ + export interface Schema$GoogleCloudVisionV1p6beta1AsyncAnnotateFileResponse { + /** + * The output location and metadata from AsyncAnnotateFileRequest. + */ + outputConfig?: Schema$GoogleCloudVisionV1p6beta1OutputConfig; + } + /** + * Response to an async batch file annotation request. + */ + export interface Schema$GoogleCloudVisionV1p6beta1AsyncBatchAnnotateFilesResponse { + /** + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. + */ + responses?: Schema$GoogleCloudVisionV1p6beta1AsyncAnnotateFileResponse[]; + } + /** + * Response to an async batch image annotation request. + */ + export interface Schema$GoogleCloudVisionV1p6beta1AsyncBatchAnnotateImagesResponse { + /** + * The output location and metadata from AsyncBatchAnnotateImagesRequest. + */ + outputConfig?: Schema$GoogleCloudVisionV1p6beta1OutputConfig; + } + /** + * A list of file annotation responses. + */ + export interface Schema$GoogleCloudVisionV1p6beta1BatchAnnotateFilesResponse { + /** + * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. + */ + responses?: Schema$GoogleCloudVisionV1p6beta1AnnotateFileResponse[]; + } + /** + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. + */ + export interface Schema$GoogleCloudVisionV1p6beta1BatchOperationMetadata { + /** + * The time when the batch request is finished and google.longrunning.Operation.done is set to true. + */ + endTime?: string; + /** + * The current state of the batch operation. + */ + state?: string; + /** + * The time when the batch request was submitted to the server. + */ + submitTime?: string; + } + /** + * Logical element on the page. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Block { + /** + * Detected block type (text, image etc) for this block. + */ + blockType?: string; + /** + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Confidence of the OCR results on the block. Range [0, 1]. + */ + confidence?: number; + /** + * List of paragraphs in this block (if this blocks is of type text). + */ + paragraphs?: Schema$GoogleCloudVisionV1p6beta1Paragraph[]; + /** + * Additional information detected for the block. + */ + property?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty; + } + /** + * A bounding polygon for the detected image annotation. + */ + export interface Schema$GoogleCloudVisionV1p6beta1BoundingPoly { + /** + * The bounding polygon normalized vertices. + */ + normalizedVertices?: Schema$GoogleCloudVisionV1p6beta1NormalizedVertex[]; + /** + * The bounding polygon vertices. + */ + vertices?: Schema$GoogleCloudVisionV1p6beta1Vertex[]; + } + /** + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ColorInfo { + /** + * RGB components of the color. + */ + color?: Schema$Color; + /** + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. + */ + pixelFraction?: number; + /** + * Image-specific score for this color. Value in range [0, 1]. + */ + score?: number; + } + /** + * Single crop hint that is used to generate a new crop when serving an image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1CropHint { + /** + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Confidence of this being a salient region. Range [0, 1]. + */ + confidence?: number; + /** + * Fraction of importance of this salient region with respect to the original image. + */ + importanceFraction?: number; + } + /** + * Set of crop hints that are used to generate new crops when serving images. + */ + export interface Schema$GoogleCloudVisionV1p6beta1CropHintsAnnotation { + /** + * Crop hint results. + */ + cropHints?: Schema$GoogleCloudVisionV1p6beta1CropHint[]; + } + /** + * Set of dominant colors and their corresponding scores. + */ + export interface Schema$GoogleCloudVisionV1p6beta1DominantColorsAnnotation { + /** + * RGB color values with their score and pixel fraction. + */ + colors?: Schema$GoogleCloudVisionV1p6beta1ColorInfo[]; + } + /** + * Set of detected entity features. + */ + export interface Schema$GoogleCloudVisionV1p6beta1EntityAnnotation { + /** + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. + */ + confidence?: number; + /** + * Entity textual description, expressed in its `locale` language. + */ + description?: string; + /** + * The language code for the locale in which the entity textual `description` is expressed. + */ + locale?: string; + /** + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. + */ + locations?: Schema$GoogleCloudVisionV1p6beta1LocationInfo[]; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). + */ + mid?: string; + /** + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. + */ + properties?: Schema$GoogleCloudVisionV1p6beta1Property[]; + /** + * Overall score of the result. Range [0, 1]. + */ + score?: number; + /** + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. + */ + topicality?: number; + } + /** + * A face annotation object contains the results of face detection. + */ + export interface Schema$GoogleCloudVisionV1p6beta1FaceAnnotation { + /** + * Anger likelihood. + */ + angerLikelihood?: string; + /** + * Blurred likelihood. + */ + blurredLikelihood?: string; + /** + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Detection confidence. Range [0, 1]. + */ + detectionConfidence?: number; + /** + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + */ + fdBoundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Headwear likelihood. + */ + headwearLikelihood?: string; + /** + * Joy likelihood. + */ + joyLikelihood?: string; + /** + * Face landmarking confidence. Range [0, 1]. + */ + landmarkingConfidence?: number; + /** + * Detected face landmarks. + */ + landmarks?: Schema$GoogleCloudVisionV1p6beta1FaceAnnotationLandmark[]; + /** + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. + */ + panAngle?: number; + /** + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. + */ + rollAngle?: number; + /** + * Sorrow likelihood. + */ + sorrowLikelihood?: string; + /** + * Surprise likelihood. + */ + surpriseLikelihood?: string; + /** + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. + */ + tiltAngle?: number; + /** + * Under-exposed likelihood. + */ + underExposedLikelihood?: string; + } + /** + * A face-specific landmark (for example, a face feature). + */ + export interface Schema$GoogleCloudVisionV1p6beta1FaceAnnotationLandmark { + /** + * Face landmark position. + */ + position?: Schema$GoogleCloudVisionV1p6beta1Position; + /** + * Face landmark type. + */ + type?: string; + } + /** + * The Google Cloud Storage location where the output will be written to. + */ + export interface Schema$GoogleCloudVisionV1p6beta1GcsDestination { + /** + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + */ + uri?: string; + } + /** + * The Google Cloud Storage location where the input will be read from. + */ + export interface Schema$GoogleCloudVisionV1p6beta1GcsSource { + /** + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. + */ + uri?: string; + } + /** + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ImageAnnotationContext { + /** + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. + */ + pageNumber?: number; + /** + * The URI of the file used to produce the image. + */ + uri?: string; + } + /** + * Stores image properties, such as dominant colors. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ImageProperties { + /** + * If present, dominant colors completed successfully. + */ + dominantColors?: Schema$GoogleCloudVisionV1p6beta1DominantColorsAnnotation; + } + /** + * Stores image quality scores, could be aesthetic quality or technical quality. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ImageQuality {} + /** + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ImportProductSetsResponse { + /** + * The list of reference_images that are imported successfully. + */ + referenceImages?: Schema$GoogleCloudVisionV1p6beta1ReferenceImage[]; + /** + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + */ + statuses?: Schema$Status[]; + } + /** + * The desired input location and metadata. + */ + export interface Schema$GoogleCloudVisionV1p6beta1InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; + /** + * The Google Cloud Storage location to read the input from. + */ + gcsSource?: Schema$GoogleCloudVisionV1p6beta1GcsSource; + /** + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. + */ + mimeType?: string; + } + /** + * Set of detected objects with bounding boxes. + */ + export interface Schema$GoogleCloudVisionV1p6beta1LocalizedObjectAnnotation { + /** + * Image region to which this object belongs. This must be populated. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + /** + * Object ID that should align with EntityAnnotation mid. + */ + mid?: string; + /** + * Object name, expressed in its `language_code` language. + */ + name?: string; + /** + * Score of the result. Range [0, 1]. + */ + score?: number; + } + /** + * Detected entity location information. + */ + export interface Schema$GoogleCloudVisionV1p6beta1LocationInfo { + /** + * lat/long location coordinates. + */ + latLng?: Schema$LatLng; + } + /** + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + */ + export interface Schema$GoogleCloudVisionV1p6beta1NormalizedVertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } + /** + * Contains metadata for the BatchAnnotateImages operation. + */ + export interface Schema$GoogleCloudVisionV1p6beta1OperationMetadata { + /** + * The time when the batch request was received. + */ + createTime?: string; + /** + * Current state of the batch operation. + */ + state?: string; + /** + * The time when the operation result was last updated. + */ + updateTime?: string; + } + /** + * The desired output location and metadata. + */ + export interface Schema$GoogleCloudVisionV1p6beta1OutputConfig { + /** + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + */ + batchSize?: number; + /** + * The Google Cloud Storage location to write the output(s) to. + */ + gcsDestination?: Schema$GoogleCloudVisionV1p6beta1GcsDestination; + } + /** + * Detected page from OCR. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Page { + /** + * List of blocks of text, images etc on this page. + */ + blocks?: Schema$GoogleCloudVisionV1p6beta1Block[]; + /** + * Confidence of the OCR results on the page. Range [0, 1]. + */ + confidence?: number; + /** + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. + */ + height?: number; + /** + * Additional information detected on the page. + */ + property?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty; + /** + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. + */ + width?: number; + } + /** + * Structural unit of text representing a number of words in certain order. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Paragraph { + /** + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Confidence of the OCR results for the paragraph. Range [0, 1]. + */ + confidence?: number; + /** + * Additional information detected for the paragraph. + */ + property?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty; + /** + * List of words in this paragraph. + */ + words?: Schema$GoogleCloudVisionV1p6beta1Word[]; + } + /** + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Position { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + /** + * Z coordinate (or depth). + */ + z?: number; + } + /** + * A Product contains ReferenceImages. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Product { + /** + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. + */ + description?: string; + /** + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. + */ + displayName?: string; + /** + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + */ + name?: string; + /** + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + */ + productCategory?: string; + /** + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. + */ + productLabels?: Schema$GoogleCloudVisionV1p6beta1ProductKeyValue[]; + } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ProductKeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + value?: string; + } + /** + * Results for a product search request. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ProductSearchResults { + /** + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. + */ + indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: Schema$GoogleCloudVisionV1p6beta1ProductSearchResultsGroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p6beta1ProductSearchResultsResult[]; + } + /** + * Information about the products similar to a single product in a query image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ProductSearchResultsGroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p6beta1ProductSearchResultsResult[]; + } + /** + * Information about a product. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ProductSearchResultsResult { + /** + * The resource name of the image from the product that is the closest match to the query. + */ + image?: string; + /** + * The Product. + */ + product?: Schema$GoogleCloudVisionV1p6beta1Product; + /** + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). + */ + score?: number; + } + /** + * A `Property` consists of a user-supplied name/value pair. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Property { + /** + * Value in range [0..1]. Confidence of this property value. + */ + confidence?: number; + /** + * Opaque property value ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). An example property for a blue coat would be: Property { name: 'color' value: 'blue' mid: '/m/01g5v' // For color blue } + */ + mid?: string; + /** + * Name of the property. + */ + name?: string; + /** + * Value of numeric properties. + */ + uint64Value?: string; + /** + * Value of the property. + */ + value?: string; + } + /** + * Stores enhanced image bytes. + */ + export interface Schema$GoogleCloudVisionV1p6beta1QualityOptimizationResult { + /** + * Optimized image bytes. + */ + image?: string; + /** + * Mime type of the output image. + */ + mimeType?: string; + /** + * Required optimization type. + */ + qualityOptimizationType?: string; + } + /** + * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ReferenceImage { + /** + * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + */ + boundingPolys?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly[]; + /** + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. + */ + name?: string; + /** + * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. + */ + uri?: string; + } + /** + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). + */ + export interface Schema$GoogleCloudVisionV1p6beta1SafeSearchAnnotation { + /** + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. + */ + adult?: string; + /** + * Likelihood that this is a medical image. + */ + medical?: string; + /** + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. + */ + racy?: string; + /** + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. + */ + spoof?: string; + /** + * Likelihood that this image contains violent content. + */ + violence?: string; + } + /** + * A single symbol representation. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Symbol { + /** + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Confidence of the OCR results for the symbol. Range [0, 1]. + */ + confidence?: number; + /** + * Additional information detected for the symbol. + */ + property?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty; + /** + * The actual UTF-8 representation of the symbol. + */ + text?: string; + } + /** + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + */ + export interface Schema$GoogleCloudVisionV1p6beta1TextAnnotation { + /** + * List of pages detected by OCR. + */ + pages?: Schema$GoogleCloudVisionV1p6beta1Page[]; + /** + * UTF-8 text detected on the pages. + */ + text?: string; + } + /** + * Detected start or end of a structural component. + */ + export interface Schema$GoogleCloudVisionV1p6beta1TextAnnotationDetectedBreak { + /** + * True if break prepends the element. + */ + isPrefix?: boolean; + /** + * Detected break type. + */ + type?: string; + } + /** + * Detected language for a structural component. + */ + export interface Schema$GoogleCloudVisionV1p6beta1TextAnnotationDetectedLanguage { + /** + * Confidence of detected language. Range [0, 1]. + */ + confidence?: number; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + } + /** + * Additional information detected on the structural component. + */ + export interface Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty { + /** + * Detected start or end of a text segment. + */ + detectedBreak?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationDetectedBreak; + /** + * A list of detected languages together with confidence. + */ + detectedLanguages?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationDetectedLanguage[]; + } + /** + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Vertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } + /** + * Relevant information for the image from the Internet. + */ + export interface Schema$GoogleCloudVisionV1p6beta1WebDetection { + /** + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. + */ + bestGuessLabels?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebLabel[]; + /** + * Fully matching images from the Internet. Can include resized copies of the query image. + */ + fullMatchingImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage[]; + /** + * Web pages containing the matching images from the Internet. + */ + pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebPage[]; + /** + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. + */ + partialMatchingImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage[]; + /** + * The visually similar image results. + */ + visuallySimilarImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage[]; + /** + * Deduced entities from similar images on the Internet. + */ + webEntities?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebEntity[]; + } + /** + * Entity deduced from similar images on the Internet. + */ + export interface Schema$GoogleCloudVisionV1p6beta1WebDetectionWebEntity { + /** + * Canonical description of the entity, in English. + */ + description?: string; + /** + * Opaque entity ID. + */ + entityId?: string; + /** + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. + */ + score?: number; + } + /** + * Metadata for online images. + */ + export interface Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage { + /** + * (Deprecated) Overall relevancy score for the image. + */ + score?: number; + /** + * The result image URL. + */ + url?: string; + } + /** + * Label to provide extra metadata for the web detection. + */ + export interface Schema$GoogleCloudVisionV1p6beta1WebDetectionWebLabel { + /** + * Label for extra metadata. + */ + label?: string; + /** + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + } + /** + * Metadata for web pages. + */ + export interface Schema$GoogleCloudVisionV1p6beta1WebDetectionWebPage { + /** + * Fully matching images on the page. Can include resized copies of the query image. + */ + fullMatchingImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage[]; + /** + * Title for the web page, may contain HTML markups. + */ + pageTitle?: string; + /** + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. + */ + partialMatchingImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage[]; + /** + * (Deprecated) Overall relevancy score for the web page. + */ + score?: number; + /** + * The result web page URL. + */ + url?: string; + } + /** + * A word representation. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Word { + /** + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Confidence of the OCR results for the word. Range [0, 1]. + */ + confidence?: number; + /** + * Additional information detected for the word. + */ + property?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty; + /** + * List of symbols in the word. The order of the symbols follows the natural reading order. + */ + symbols?: Schema$GoogleCloudVisionV1p6beta1Symbol[]; + } /** * Information about the products similar to a single product in a query image. */ @@ -5241,7 +6180,7 @@ export namespace vision_v1 { */ gcsSource?: Schema$GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -5548,7 +6487,7 @@ export namespace vision_v1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -5569,7 +6508,7 @@ export namespace vision_v1 { */ filter?: string; /** - * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods", "apparel", or "toys" should be specified. + * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", or "toys-v2" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well. */ productCategories?: string[]; /** @@ -5701,7 +6640,7 @@ export namespace vision_v1 { violence?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -5914,6 +6853,53 @@ export namespace vision_v1 { /** * vision.files.annotate * @desc Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * vision.files.annotate(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.files.annotate * @memberOf! () * @@ -5991,6 +6977,53 @@ export namespace vision_v1 { /** * vision.files.asyncBatchAnnotate * @desc Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * vision.files.asyncBatchAnnotate(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.files.asyncBatchAnnotate * @memberOf! () * @@ -6099,7 +7132,7 @@ export namespace vision_v1 { * @example * * // BEFORE RUNNING: * // --------------- - * // 1. If not already done, enable the Google Cloud Vision API + * // 1. If not already done, enable the Cloud Vision API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/vision * // 2. This sample uses Application Default Credentials for authentication. @@ -6111,7 +7144,7 @@ export namespace vision_v1 { * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * - * var google = require('googleapis'); + * const {google} = require('googleapis'); * var vision = google.vision('v1'); * * authorize(function(authClient) { @@ -6135,16 +7168,12 @@ export namespace vision_v1 { * }); * * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); * }); * } * @alias vision.images.annotate @@ -6227,6 +7256,53 @@ export namespace vision_v1 { /** * vision.images.asyncBatchAnnotate * @desc Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * vision.images.asyncBatchAnnotate(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.images.asyncBatchAnnotate * @memberOf! () * @@ -6341,6 +7417,52 @@ export namespace vision_v1 { /** * vision.locations.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. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the operation resource. + * name: 'locations/my-location/operations/my-operation', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * vision.locations.operations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.locations.operations.get * @memberOf! () * @@ -6432,6 +7554,53 @@ export namespace vision_v1 { /** * vision.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`. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the operation resource to be cancelled. + * name: 'operations/my-operation', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * vision.operations.cancel(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.operations.cancel * @memberOf! () * @@ -6502,6 +7671,49 @@ export namespace vision_v1 { /** * vision.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`. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the operation resource to be deleted. + * name: 'operations/my-operation', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * vision.operations.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.operations.delete * @memberOf! () * @@ -6571,6 +7783,52 @@ export namespace vision_v1 { /** * vision.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. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the operation resource. + * name: 'operations/my-operation', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * vision.operations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.operations.get * @memberOf! () * @@ -6641,6 +7899,65 @@ export namespace vision_v1 { /** * vision.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. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the operation's parent resource. + * name: 'operations', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var operationsPage = response['operations']; + * if (!operationsPage) { + * return; + * } + * for (var i = 0; i < operationsPage.length; i++) { + * // TODO: Change code below to process each resource in `operationsPage`: + * console.log(JSON.stringify(operationsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * vision.operations.list(request, handlePage); + * } + * }; + * + * vision.operations.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.operations.list * @memberOf! () * @@ -6815,6 +8132,52 @@ export namespace vision_v1 { /** * vision.projects.locations.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. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/operations/my-operation', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * vision.projects.locations.operations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.operations.get * @memberOf! () * @@ -6910,6 +8273,58 @@ export namespace vision_v1 { /** * vision.projects.locations.products.create * @desc Creates and returns a new product resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is missing or invalid. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The project in which the Product should be created. + * // Format is + * // `projects/PROJECT_ID/locations/LOC_ID`. + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * vision.projects.locations.products.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.products.create * @memberOf! () * @@ -6984,6 +8399,51 @@ export namespace vision_v1 { /** * vision.projects.locations.products.delete * @desc Permanently deletes a product and its reference images. Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work until all related caches are refreshed. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Resource name of product to delete. + * // Format is: + * // `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * name: 'projects/my-project/locations/my-location/products/my-product', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * vision.projects.locations.products.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.products.delete * @memberOf! () * @@ -7053,6 +8513,54 @@ export namespace vision_v1 { /** * vision.projects.locations.products.get * @desc Gets information associated with a Product. Possible errors: * Returns NOT_FOUND if the Product does not exist. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Resource name of the Product to get. + * // Format is: + * // `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * name: 'projects/my-project/locations/my-location/products/my-product', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * vision.projects.locations.products.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.products.get * @memberOf! () * @@ -7122,6 +8630,67 @@ export namespace vision_v1 { /** * vision.projects.locations.products.list * @desc Lists products in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The project OR ProductSet from which Products should be listed. + * // Format: + * // `projects/PROJECT_ID/locations/LOC_ID` + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var productsPage = response['products']; + * if (!productsPage) { + * return; + * } + * for (var i = 0; i < productsPage.length; i++) { + * // TODO: Change code below to process each resource in `productsPage`: + * console.log(JSON.stringify(productsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * vision.projects.locations.products.list(request, handlePage); + * } + * }; + * + * vision.projects.locations.products.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.products.list * @memberOf! () * @@ -7200,6 +8769,60 @@ export namespace vision_v1 { /** * vision.projects.locations.products.patch * @desc Makes changes to a Product resource. Only the `display_name`, `description`, and `labels` fields can be updated right now. If labels are updated, the change will not be reflected in queries until the next index time. Possible errors: * Returns NOT_FOUND if the Product does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but is missing from the request or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is present in update_mask but is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is present in update_mask. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the product. + * // Format is: + * // `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + * // This field is ignored when creating a product. + * name: 'projects/my-project/locations/my-location/products/my-product', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * vision.projects.locations.products.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.products.patch * @memberOf! () * @@ -7365,6 +8988,58 @@ export namespace vision_v1 { /** * vision.projects.locations.products.referenceImages.create * @desc Creates and returns a new ReferenceImage resource. The `bounding_poly` field is optional. If `bounding_poly` is not specified, the system will try to detect regions of interest in the image that are compatible with the product_category on the parent product. If it is specified, detection is ALWAYS skipped. The system converts polygons into non-rotated rectangles. Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP). Possible errors: * Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if the product does not exist. * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected. * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Resource name of the product in which to create the reference image. + * // Format is + * // `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + * parent: 'projects/my-project/locations/my-location/products/my-product', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * vision.projects.locations.products.referenceImages.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.products.referenceImages.create * @memberOf! () * @@ -7441,6 +9116,51 @@ export namespace vision_v1 { /** * vision.projects.locations.products.referenceImages.delete * @desc Permanently deletes a reference image. The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed. The actual image files are not deleted from Google Cloud Storage. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the reference image to delete. + * // Format is: + * // `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` + * name: 'projects/my-project/locations/my-location/products/my-product/referenceImages/my-reference-image', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * vision.projects.locations.products.referenceImages.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.products.referenceImages.delete * @memberOf! () * @@ -7510,6 +9230,54 @@ export namespace vision_v1 { /** * vision.projects.locations.products.referenceImages.get * @desc Gets information associated with a ReferenceImage. Possible errors: * Returns NOT_FOUND if the specified image does not exist. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the ReferenceImage to get. + * // Format is: + * // `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. + * name: 'projects/my-project/locations/my-location/products/my-product/referenceImages/my-reference-image', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * vision.projects.locations.products.referenceImages.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.products.referenceImages.get * @memberOf! () * @@ -7581,6 +9349,67 @@ export namespace vision_v1 { /** * vision.projects.locations.products.referenceImages.list * @desc Lists reference images. Possible errors: * Returns NOT_FOUND if the parent product does not exist. * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less than 1. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Resource name of the product containing the reference images. + * // Format is + * // `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + * parent: 'projects/my-project/locations/my-location/products/my-product', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var referenceImagesPage = response['referenceImages']; + * if (!referenceImagesPage) { + * return; + * } + * for (var i = 0; i < referenceImagesPage.length; i++) { + * // TODO: Change code below to process each resource in `referenceImagesPage`: + * console.log(JSON.stringify(referenceImagesPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * vision.projects.locations.products.referenceImages.list(request, handlePage); + * } + * }; + * + * vision.projects.locations.products.referenceImages.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.products.referenceImages.list * @memberOf! () * @@ -7741,6 +9570,55 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.addProduct * @desc Adds a Product to the specified ProductSet. If the Product is already present, no change is made. One Product can be added to at most 100 ProductSets. Possible errors: * Returns NOT_FOUND if the Product or the ProductSet doesn't exist. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name for the ProductSet to modify. + * // Format is: + * // `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * name: 'projects/my-project/locations/my-location/productSets/my-product-set', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * vision.projects.locations.productSets.addProduct(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.productSets.addProduct * @memberOf! () * @@ -7814,6 +9692,57 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.create * @desc Creates and returns a new ProductSet resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The project in which the ProductSet should be created. + * // Format is `projects/PROJECT_ID/locations/LOC_ID`. + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * vision.projects.locations.productSets.create(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.productSets.create * @memberOf! () * @@ -7890,6 +9819,51 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.delete * @desc Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted. The actual image files are not deleted from Google Cloud Storage. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Resource name of the ProductSet to delete. + * // Format is: + * // `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * name: 'projects/my-project/locations/my-location/productSets/my-product-set', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * vision.projects.locations.productSets.delete(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.productSets.delete * @memberOf! () * @@ -7959,6 +9933,54 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.get * @desc Gets information associated with a ProductSet. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Resource name of the ProductSet to get. + * // Format is: + * // `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID` + * name: 'projects/my-project/locations/my-location/productSets/my-product-set', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * vision.projects.locations.productSets.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.productSets.get * @memberOf! () * @@ -8030,6 +10052,57 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.import * @desc Asynchronous API that imports a list of reference images to specified product sets based on a list of image information. The google.longrunning.Operation API can be used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) `Operation.response` contains `ImportProductSetsResponse`. (results) The input source of this method is a csv file on Google Cloud Storage. For the format of the csv file please see ImportProductSetsGcsSource.csv_file_uri. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The project in which the ProductSets should be imported. + * // Format is `projects/PROJECT_ID/locations/LOC_ID`. + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * vision.projects.locations.productSets.import(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.productSets.import * @memberOf! () * @@ -8105,6 +10178,66 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.list * @desc Lists ProductSets in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The project from which ProductSets should be listed. + * // Format is `projects/PROJECT_ID/locations/LOC_ID`. + * parent: 'projects/my-project/locations/my-location', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var productSetsPage = response['productSets']; + * if (!productSetsPage) { + * return; + * } + * for (var i = 0; i < productSetsPage.length; i++) { + * // TODO: Change code below to process each resource in `productSetsPage`: + * console.log(JSON.stringify(productSetsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * vision.projects.locations.productSets.list(request, handlePage); + * } + * }; + * + * vision.projects.locations.productSets.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.productSets.list * @memberOf! () * @@ -8183,6 +10316,60 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.patch * @desc Makes changes to a ProductSet resource. Only display_name can be updated currently. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but missing from the request or longer than 4096 characters. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name of the ProductSet. + * // Format is: + * // `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. + * // This field is ignored when creating a ProductSet. + * name: 'projects/my-project/locations/my-location/productSets/my-product-set', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. Only these properties + * // will be changed. + * }, + * + * auth: authClient, + * }; + * + * vision.projects.locations.productSets.patch(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.productSets.patch * @memberOf! () * @@ -8256,6 +10443,55 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.removeProduct * @desc Removes a Product from the specified ProductSet. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The resource name for the ProductSet to modify. + * // Format is: + * // `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * name: 'projects/my-project/locations/my-location/productSets/my-product-set', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * vision.projects.locations.productSets.removeProduct(request, function(err) { + * if (err) { + * console.error(err); + * return; + * } + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.productSets.removeProduct * @memberOf! () * @@ -8474,6 +10710,67 @@ export namespace vision_v1 { /** * vision.projects.locations.productSets.products.list * @desc Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The ProductSet resource for which to retrieve Products. + * // Format is: + * // `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * name: 'projects/my-project/locations/my-location/productSets/my-product-set', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * var handlePage = function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * var productsPage = response['products']; + * if (!productsPage) { + * return; + * } + * for (var i = 0; i < productsPage.length; i++) { + * // TODO: Change code below to process each resource in `productsPage`: + * console.log(JSON.stringify(productsPage[i], null, 2)); + * } + * + * if (response.nextPageToken) { + * request.pageToken = response.nextPageToken; + * vision.projects.locations.productSets.products.list(request, handlePage); + * } + * }; + * + * vision.projects.locations.productSets.products.list(request, handlePage); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.locations.productSets.products.list * @memberOf! () * @@ -8587,6 +10884,52 @@ export namespace vision_v1 { /** * vision.projects.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. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Cloud Vision API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/vision + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * const {google} = require('googleapis'); + * var vision = google.vision('v1'); + * + * authorize(function(authClient) { + * var request = { + * // The name of the operation resource. + * name: 'projects/my-project/operations/my-operation', // TODO: Update placeholder value. + * + * auth: authClient, + * }; + * + * vision.projects.operations.get(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getClient({ + * scopes: ['https://www.googleapis.com/auth/cloud-platform'] + * }).then(client => { + * callback(client); + * }).catch(err => { + * console.error('authentication failed: ', err); + * }); + * } * @alias vision.projects.operations.get * @memberOf! () * diff --git a/src/apis/vision/v1p1beta1.ts b/src/apis/vision/v1p1beta1.ts index f389aad3446..e4603ad898d 100644 --- a/src/apis/vision/v1p1beta1.ts +++ b/src/apis/vision/v1p1beta1.ts @@ -1063,7 +1063,7 @@ export namespace vision_v1p1beta1 { */ gcsSource?: Schema$GoogleCloudVisionV1p1beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -1237,7 +1237,7 @@ export namespace vision_v1p1beta1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -1271,7 +1271,7 @@ export namespace vision_v1p1beta1 { */ filter?: string; /** - * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods", "apparel", or "toys" should be specified. + * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", or "toys-v2" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well. */ productCategories?: string[]; /** @@ -1939,7 +1939,7 @@ export namespace vision_v1p1beta1 { */ gcsSource?: Schema$GoogleCloudVisionV1p2beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -2100,7 +2100,7 @@ export namespace vision_v1p1beta1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -2802,7 +2802,7 @@ export namespace vision_v1p1beta1 { */ gcsSource?: Schema$GoogleCloudVisionV1p3beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -2963,7 +2963,7 @@ export namespace vision_v1p1beta1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -3700,7 +3700,7 @@ export namespace vision_v1p1beta1 { */ gcsSource?: Schema$GoogleCloudVisionV1p4beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -3861,7 +3861,7 @@ export namespace vision_v1p1beta1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -4610,7 +4610,7 @@ export namespace vision_v1p1beta1 { */ gcsSource?: Schema$GoogleCloudVisionV1p5beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -4804,7 +4804,7 @@ export namespace vision_v1p1beta1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -5182,6 +5182,945 @@ export namespace vision_v1p1beta1 { */ symbols?: Schema$GoogleCloudVisionV1p5beta1Symbol[]; } + /** + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. + */ + export interface Schema$GoogleCloudVisionV1p6beta1AnnotateFileResponse { + /** + * Information about the file for which this response is generated. + */ + inputConfig?: Schema$GoogleCloudVisionV1p6beta1InputConfig; + /** + * Individual responses to images found within the file. + */ + responses?: Schema$GoogleCloudVisionV1p6beta1AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; + } + /** + * Response to an image annotation request. + */ + export interface Schema$GoogleCloudVisionV1p6beta1AnnotateImageResponse { + /** + * If present, contextual information is needed to understand where this image comes from. + */ + context?: Schema$GoogleCloudVisionV1p6beta1ImageAnnotationContext; + /** + * If present, crop hints have completed successfully. + */ + cropHintsAnnotation?: Schema$GoogleCloudVisionV1p6beta1CropHintsAnnotation; + /** + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. + */ + error?: Schema$Status; + /** + * If present, face detection has completed successfully. + */ + faceAnnotations?: Schema$GoogleCloudVisionV1p6beta1FaceAnnotation[]; + /** + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. + */ + fullTextAnnotation?: Schema$GoogleCloudVisionV1p6beta1TextAnnotation; + /** + * If present, image properties were extracted successfully. + */ + imagePropertiesAnnotation?: Schema$GoogleCloudVisionV1p6beta1ImageProperties; + /** + * If present, image quality calculation has completed successfully. + */ + imageQualityAnnotation?: Schema$GoogleCloudVisionV1p6beta1ImageQuality; + /** + * If present, label detection has completed successfully. + */ + labelAnnotations?: Schema$GoogleCloudVisionV1p6beta1EntityAnnotation[]; + /** + * If present, landmark detection has completed successfully. + */ + landmarkAnnotations?: Schema$GoogleCloudVisionV1p6beta1EntityAnnotation[]; + /** + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. + */ + localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p6beta1LocalizedObjectAnnotation[]; + /** + * If present, logo detection has completed successfully. + */ + logoAnnotations?: Schema$GoogleCloudVisionV1p6beta1EntityAnnotation[]; + /** + * If present, objects attributes calculation has completed successfully. The attributes value will be filled in the EntityAnnotation.properties. Example: object_attribute_annotations { properties { name: "color" value: "blue" confidence: 0.1 } properties { name: "color" value: "white" confidence: 0.2 } properties { name: "material" value: "silk" confidence: 0.3 } } + */ + objectAttributeAnnotations?: Schema$GoogleCloudVisionV1p6beta1EntityAnnotation[]; + /** + * If present, product search has completed successfully. + */ + productSearchResults?: Schema$GoogleCloudVisionV1p6beta1ProductSearchResults; + /** + * If present, image quality optimization has completed successfully. + */ + qualityOptimizationResult?: Schema$GoogleCloudVisionV1p6beta1QualityOptimizationResult; + /** + * If present, safe-search annotation has completed successfully. + */ + safeSearchAnnotation?: Schema$GoogleCloudVisionV1p6beta1SafeSearchAnnotation; + /** + * If present, text (OCR) detection has completed successfully. + */ + textAnnotations?: Schema$GoogleCloudVisionV1p6beta1EntityAnnotation[]; + /** + * If present, web detection has completed successfully. + */ + webDetection?: Schema$GoogleCloudVisionV1p6beta1WebDetection; + } + /** + * The response for a single offline file annotation request. + */ + export interface Schema$GoogleCloudVisionV1p6beta1AsyncAnnotateFileResponse { + /** + * The output location and metadata from AsyncAnnotateFileRequest. + */ + outputConfig?: Schema$GoogleCloudVisionV1p6beta1OutputConfig; + } + /** + * Response to an async batch file annotation request. + */ + export interface Schema$GoogleCloudVisionV1p6beta1AsyncBatchAnnotateFilesResponse { + /** + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. + */ + responses?: Schema$GoogleCloudVisionV1p6beta1AsyncAnnotateFileResponse[]; + } + /** + * Response to an async batch image annotation request. + */ + export interface Schema$GoogleCloudVisionV1p6beta1AsyncBatchAnnotateImagesResponse { + /** + * The output location and metadata from AsyncBatchAnnotateImagesRequest. + */ + outputConfig?: Schema$GoogleCloudVisionV1p6beta1OutputConfig; + } + /** + * A list of file annotation responses. + */ + export interface Schema$GoogleCloudVisionV1p6beta1BatchAnnotateFilesResponse { + /** + * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. + */ + responses?: Schema$GoogleCloudVisionV1p6beta1AnnotateFileResponse[]; + } + /** + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. + */ + export interface Schema$GoogleCloudVisionV1p6beta1BatchOperationMetadata { + /** + * The time when the batch request is finished and google.longrunning.Operation.done is set to true. + */ + endTime?: string; + /** + * The current state of the batch operation. + */ + state?: string; + /** + * The time when the batch request was submitted to the server. + */ + submitTime?: string; + } + /** + * Logical element on the page. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Block { + /** + * Detected block type (text, image etc) for this block. + */ + blockType?: string; + /** + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Confidence of the OCR results on the block. Range [0, 1]. + */ + confidence?: number; + /** + * List of paragraphs in this block (if this blocks is of type text). + */ + paragraphs?: Schema$GoogleCloudVisionV1p6beta1Paragraph[]; + /** + * Additional information detected for the block. + */ + property?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty; + } + /** + * A bounding polygon for the detected image annotation. + */ + export interface Schema$GoogleCloudVisionV1p6beta1BoundingPoly { + /** + * The bounding polygon normalized vertices. + */ + normalizedVertices?: Schema$GoogleCloudVisionV1p6beta1NormalizedVertex[]; + /** + * The bounding polygon vertices. + */ + vertices?: Schema$GoogleCloudVisionV1p6beta1Vertex[]; + } + /** + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ColorInfo { + /** + * RGB components of the color. + */ + color?: Schema$Color; + /** + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. + */ + pixelFraction?: number; + /** + * Image-specific score for this color. Value in range [0, 1]. + */ + score?: number; + } + /** + * Single crop hint that is used to generate a new crop when serving an image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1CropHint { + /** + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Confidence of this being a salient region. Range [0, 1]. + */ + confidence?: number; + /** + * Fraction of importance of this salient region with respect to the original image. + */ + importanceFraction?: number; + } + /** + * Set of crop hints that are used to generate new crops when serving images. + */ + export interface Schema$GoogleCloudVisionV1p6beta1CropHintsAnnotation { + /** + * Crop hint results. + */ + cropHints?: Schema$GoogleCloudVisionV1p6beta1CropHint[]; + } + /** + * Set of dominant colors and their corresponding scores. + */ + export interface Schema$GoogleCloudVisionV1p6beta1DominantColorsAnnotation { + /** + * RGB color values with their score and pixel fraction. + */ + colors?: Schema$GoogleCloudVisionV1p6beta1ColorInfo[]; + } + /** + * Set of detected entity features. + */ + export interface Schema$GoogleCloudVisionV1p6beta1EntityAnnotation { + /** + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. + */ + confidence?: number; + /** + * Entity textual description, expressed in its `locale` language. + */ + description?: string; + /** + * The language code for the locale in which the entity textual `description` is expressed. + */ + locale?: string; + /** + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. + */ + locations?: Schema$GoogleCloudVisionV1p6beta1LocationInfo[]; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). + */ + mid?: string; + /** + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. + */ + properties?: Schema$GoogleCloudVisionV1p6beta1Property[]; + /** + * Overall score of the result. Range [0, 1]. + */ + score?: number; + /** + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. + */ + topicality?: number; + } + /** + * A face annotation object contains the results of face detection. + */ + export interface Schema$GoogleCloudVisionV1p6beta1FaceAnnotation { + /** + * Anger likelihood. + */ + angerLikelihood?: string; + /** + * Blurred likelihood. + */ + blurredLikelihood?: string; + /** + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Detection confidence. Range [0, 1]. + */ + detectionConfidence?: number; + /** + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + */ + fdBoundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Headwear likelihood. + */ + headwearLikelihood?: string; + /** + * Joy likelihood. + */ + joyLikelihood?: string; + /** + * Face landmarking confidence. Range [0, 1]. + */ + landmarkingConfidence?: number; + /** + * Detected face landmarks. + */ + landmarks?: Schema$GoogleCloudVisionV1p6beta1FaceAnnotationLandmark[]; + /** + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. + */ + panAngle?: number; + /** + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. + */ + rollAngle?: number; + /** + * Sorrow likelihood. + */ + sorrowLikelihood?: string; + /** + * Surprise likelihood. + */ + surpriseLikelihood?: string; + /** + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. + */ + tiltAngle?: number; + /** + * Under-exposed likelihood. + */ + underExposedLikelihood?: string; + } + /** + * A face-specific landmark (for example, a face feature). + */ + export interface Schema$GoogleCloudVisionV1p6beta1FaceAnnotationLandmark { + /** + * Face landmark position. + */ + position?: Schema$GoogleCloudVisionV1p6beta1Position; + /** + * Face landmark type. + */ + type?: string; + } + /** + * The Google Cloud Storage location where the output will be written to. + */ + export interface Schema$GoogleCloudVisionV1p6beta1GcsDestination { + /** + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + */ + uri?: string; + } + /** + * The Google Cloud Storage location where the input will be read from. + */ + export interface Schema$GoogleCloudVisionV1p6beta1GcsSource { + /** + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. + */ + uri?: string; + } + /** + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ImageAnnotationContext { + /** + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. + */ + pageNumber?: number; + /** + * The URI of the file used to produce the image. + */ + uri?: string; + } + /** + * Stores image properties, such as dominant colors. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ImageProperties { + /** + * If present, dominant colors completed successfully. + */ + dominantColors?: Schema$GoogleCloudVisionV1p6beta1DominantColorsAnnotation; + } + /** + * Stores image quality scores, could be aesthetic quality or technical quality. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ImageQuality {} + /** + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ImportProductSetsResponse { + /** + * The list of reference_images that are imported successfully. + */ + referenceImages?: Schema$GoogleCloudVisionV1p6beta1ReferenceImage[]; + /** + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + */ + statuses?: Schema$Status[]; + } + /** + * The desired input location and metadata. + */ + export interface Schema$GoogleCloudVisionV1p6beta1InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; + /** + * The Google Cloud Storage location to read the input from. + */ + gcsSource?: Schema$GoogleCloudVisionV1p6beta1GcsSource; + /** + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. + */ + mimeType?: string; + } + /** + * Set of detected objects with bounding boxes. + */ + export interface Schema$GoogleCloudVisionV1p6beta1LocalizedObjectAnnotation { + /** + * Image region to which this object belongs. This must be populated. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + /** + * Object ID that should align with EntityAnnotation mid. + */ + mid?: string; + /** + * Object name, expressed in its `language_code` language. + */ + name?: string; + /** + * Score of the result. Range [0, 1]. + */ + score?: number; + } + /** + * Detected entity location information. + */ + export interface Schema$GoogleCloudVisionV1p6beta1LocationInfo { + /** + * lat/long location coordinates. + */ + latLng?: Schema$LatLng; + } + /** + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + */ + export interface Schema$GoogleCloudVisionV1p6beta1NormalizedVertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } + /** + * Contains metadata for the BatchAnnotateImages operation. + */ + export interface Schema$GoogleCloudVisionV1p6beta1OperationMetadata { + /** + * The time when the batch request was received. + */ + createTime?: string; + /** + * Current state of the batch operation. + */ + state?: string; + /** + * The time when the operation result was last updated. + */ + updateTime?: string; + } + /** + * The desired output location and metadata. + */ + export interface Schema$GoogleCloudVisionV1p6beta1OutputConfig { + /** + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + */ + batchSize?: number; + /** + * The Google Cloud Storage location to write the output(s) to. + */ + gcsDestination?: Schema$GoogleCloudVisionV1p6beta1GcsDestination; + } + /** + * Detected page from OCR. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Page { + /** + * List of blocks of text, images etc on this page. + */ + blocks?: Schema$GoogleCloudVisionV1p6beta1Block[]; + /** + * Confidence of the OCR results on the page. Range [0, 1]. + */ + confidence?: number; + /** + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. + */ + height?: number; + /** + * Additional information detected on the page. + */ + property?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty; + /** + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. + */ + width?: number; + } + /** + * Structural unit of text representing a number of words in certain order. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Paragraph { + /** + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Confidence of the OCR results for the paragraph. Range [0, 1]. + */ + confidence?: number; + /** + * Additional information detected for the paragraph. + */ + property?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty; + /** + * List of words in this paragraph. + */ + words?: Schema$GoogleCloudVisionV1p6beta1Word[]; + } + /** + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Position { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + /** + * Z coordinate (or depth). + */ + z?: number; + } + /** + * A Product contains ReferenceImages. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Product { + /** + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. + */ + description?: string; + /** + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. + */ + displayName?: string; + /** + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + */ + name?: string; + /** + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + */ + productCategory?: string; + /** + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. + */ + productLabels?: Schema$GoogleCloudVisionV1p6beta1ProductKeyValue[]; + } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ProductKeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + value?: string; + } + /** + * Results for a product search request. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ProductSearchResults { + /** + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. + */ + indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: Schema$GoogleCloudVisionV1p6beta1ProductSearchResultsGroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p6beta1ProductSearchResultsResult[]; + } + /** + * Information about the products similar to a single product in a query image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ProductSearchResultsGroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p6beta1ProductSearchResultsResult[]; + } + /** + * Information about a product. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ProductSearchResultsResult { + /** + * The resource name of the image from the product that is the closest match to the query. + */ + image?: string; + /** + * The Product. + */ + product?: Schema$GoogleCloudVisionV1p6beta1Product; + /** + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). + */ + score?: number; + } + /** + * A `Property` consists of a user-supplied name/value pair. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Property { + /** + * Value in range [0..1]. Confidence of this property value. + */ + confidence?: number; + /** + * Opaque property value ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). An example property for a blue coat would be: Property { name: 'color' value: 'blue' mid: '/m/01g5v' // For color blue } + */ + mid?: string; + /** + * Name of the property. + */ + name?: string; + /** + * Value of numeric properties. + */ + uint64Value?: string; + /** + * Value of the property. + */ + value?: string; + } + /** + * Stores enhanced image bytes. + */ + export interface Schema$GoogleCloudVisionV1p6beta1QualityOptimizationResult { + /** + * Optimized image bytes. + */ + image?: string; + /** + * Mime type of the output image. + */ + mimeType?: string; + /** + * Required optimization type. + */ + qualityOptimizationType?: string; + } + /** + * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ReferenceImage { + /** + * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + */ + boundingPolys?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly[]; + /** + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. + */ + name?: string; + /** + * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. + */ + uri?: string; + } + /** + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). + */ + export interface Schema$GoogleCloudVisionV1p6beta1SafeSearchAnnotation { + /** + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. + */ + adult?: string; + /** + * Likelihood that this is a medical image. + */ + medical?: string; + /** + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. + */ + racy?: string; + /** + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. + */ + spoof?: string; + /** + * Likelihood that this image contains violent content. + */ + violence?: string; + } + /** + * A single symbol representation. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Symbol { + /** + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Confidence of the OCR results for the symbol. Range [0, 1]. + */ + confidence?: number; + /** + * Additional information detected for the symbol. + */ + property?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty; + /** + * The actual UTF-8 representation of the symbol. + */ + text?: string; + } + /** + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + */ + export interface Schema$GoogleCloudVisionV1p6beta1TextAnnotation { + /** + * List of pages detected by OCR. + */ + pages?: Schema$GoogleCloudVisionV1p6beta1Page[]; + /** + * UTF-8 text detected on the pages. + */ + text?: string; + } + /** + * Detected start or end of a structural component. + */ + export interface Schema$GoogleCloudVisionV1p6beta1TextAnnotationDetectedBreak { + /** + * True if break prepends the element. + */ + isPrefix?: boolean; + /** + * Detected break type. + */ + type?: string; + } + /** + * Detected language for a structural component. + */ + export interface Schema$GoogleCloudVisionV1p6beta1TextAnnotationDetectedLanguage { + /** + * Confidence of detected language. Range [0, 1]. + */ + confidence?: number; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + } + /** + * Additional information detected on the structural component. + */ + export interface Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty { + /** + * Detected start or end of a text segment. + */ + detectedBreak?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationDetectedBreak; + /** + * A list of detected languages together with confidence. + */ + detectedLanguages?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationDetectedLanguage[]; + } + /** + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Vertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } + /** + * Relevant information for the image from the Internet. + */ + export interface Schema$GoogleCloudVisionV1p6beta1WebDetection { + /** + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. + */ + bestGuessLabels?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebLabel[]; + /** + * Fully matching images from the Internet. Can include resized copies of the query image. + */ + fullMatchingImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage[]; + /** + * Web pages containing the matching images from the Internet. + */ + pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebPage[]; + /** + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. + */ + partialMatchingImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage[]; + /** + * The visually similar image results. + */ + visuallySimilarImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage[]; + /** + * Deduced entities from similar images on the Internet. + */ + webEntities?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebEntity[]; + } + /** + * Entity deduced from similar images on the Internet. + */ + export interface Schema$GoogleCloudVisionV1p6beta1WebDetectionWebEntity { + /** + * Canonical description of the entity, in English. + */ + description?: string; + /** + * Opaque entity ID. + */ + entityId?: string; + /** + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. + */ + score?: number; + } + /** + * Metadata for online images. + */ + export interface Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage { + /** + * (Deprecated) Overall relevancy score for the image. + */ + score?: number; + /** + * The result image URL. + */ + url?: string; + } + /** + * Label to provide extra metadata for the web detection. + */ + export interface Schema$GoogleCloudVisionV1p6beta1WebDetectionWebLabel { + /** + * Label for extra metadata. + */ + label?: string; + /** + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + } + /** + * Metadata for web pages. + */ + export interface Schema$GoogleCloudVisionV1p6beta1WebDetectionWebPage { + /** + * Fully matching images on the page. Can include resized copies of the query image. + */ + fullMatchingImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage[]; + /** + * Title for the web page, may contain HTML markups. + */ + pageTitle?: string; + /** + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. + */ + partialMatchingImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage[]; + /** + * (Deprecated) Overall relevancy score for the web page. + */ + score?: number; + /** + * The result web page URL. + */ + url?: string; + } + /** + * A word representation. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Word { + /** + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Confidence of the OCR results for the word. Range [0, 1]. + */ + confidence?: number; + /** + * Additional information detected for the word. + */ + property?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty; + /** + * List of symbols in the word. The order of the symbols follows the natural reading order. + */ + symbols?: Schema$GoogleCloudVisionV1p6beta1Symbol[]; + } /** * Information about the products similar to a single product in a query image. */ @@ -5243,7 +6182,7 @@ export namespace vision_v1p1beta1 { */ gcsSource?: Schema$GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -5468,7 +6407,7 @@ export namespace vision_v1p1beta1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -5570,7 +6509,7 @@ export namespace vision_v1p1beta1 { violence?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/vision/v1p2beta1.ts b/src/apis/vision/v1p2beta1.ts index 069154f5f6a..6b57cee6fcc 100644 --- a/src/apis/vision/v1p2beta1.ts +++ b/src/apis/vision/v1p2beta1.ts @@ -869,7 +869,7 @@ export namespace vision_v1p2beta1 { */ gcsSource?: Schema$GoogleCloudVisionV1p1beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -1030,7 +1030,7 @@ export namespace vision_v1p2beta1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -1896,7 +1896,7 @@ export namespace vision_v1p2beta1 { */ gcsSource?: Schema$GoogleCloudVisionV1p2beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -2070,7 +2070,7 @@ export namespace vision_v1p2beta1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -2104,7 +2104,7 @@ export namespace vision_v1p2beta1 { */ filter?: string; /** - * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods", "apparel", or "toys" should be specified. + * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", or "toys-v2" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well. */ productCategories?: string[]; /** @@ -2802,7 +2802,7 @@ export namespace vision_v1p2beta1 { */ gcsSource?: Schema$GoogleCloudVisionV1p3beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -2963,7 +2963,7 @@ export namespace vision_v1p2beta1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -3700,7 +3700,7 @@ export namespace vision_v1p2beta1 { */ gcsSource?: Schema$GoogleCloudVisionV1p4beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -3861,7 +3861,7 @@ export namespace vision_v1p2beta1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -4610,7 +4610,7 @@ export namespace vision_v1p2beta1 { */ gcsSource?: Schema$GoogleCloudVisionV1p5beta1GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -4804,7 +4804,7 @@ export namespace vision_v1p2beta1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -5182,6 +5182,945 @@ export namespace vision_v1p2beta1 { */ symbols?: Schema$GoogleCloudVisionV1p5beta1Symbol[]; } + /** + * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. + */ + export interface Schema$GoogleCloudVisionV1p6beta1AnnotateFileResponse { + /** + * Information about the file for which this response is generated. + */ + inputConfig?: Schema$GoogleCloudVisionV1p6beta1InputConfig; + /** + * Individual responses to images found within the file. + */ + responses?: Schema$GoogleCloudVisionV1p6beta1AnnotateImageResponse[]; + /** + * This field gives the total number of pages in the file. + */ + totalPages?: number; + } + /** + * Response to an image annotation request. + */ + export interface Schema$GoogleCloudVisionV1p6beta1AnnotateImageResponse { + /** + * If present, contextual information is needed to understand where this image comes from. + */ + context?: Schema$GoogleCloudVisionV1p6beta1ImageAnnotationContext; + /** + * If present, crop hints have completed successfully. + */ + cropHintsAnnotation?: Schema$GoogleCloudVisionV1p6beta1CropHintsAnnotation; + /** + * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. + */ + error?: Schema$Status; + /** + * If present, face detection has completed successfully. + */ + faceAnnotations?: Schema$GoogleCloudVisionV1p6beta1FaceAnnotation[]; + /** + * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. + */ + fullTextAnnotation?: Schema$GoogleCloudVisionV1p6beta1TextAnnotation; + /** + * If present, image properties were extracted successfully. + */ + imagePropertiesAnnotation?: Schema$GoogleCloudVisionV1p6beta1ImageProperties; + /** + * If present, image quality calculation has completed successfully. + */ + imageQualityAnnotation?: Schema$GoogleCloudVisionV1p6beta1ImageQuality; + /** + * If present, label detection has completed successfully. + */ + labelAnnotations?: Schema$GoogleCloudVisionV1p6beta1EntityAnnotation[]; + /** + * If present, landmark detection has completed successfully. + */ + landmarkAnnotations?: Schema$GoogleCloudVisionV1p6beta1EntityAnnotation[]; + /** + * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. + */ + localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p6beta1LocalizedObjectAnnotation[]; + /** + * If present, logo detection has completed successfully. + */ + logoAnnotations?: Schema$GoogleCloudVisionV1p6beta1EntityAnnotation[]; + /** + * If present, objects attributes calculation has completed successfully. The attributes value will be filled in the EntityAnnotation.properties. Example: object_attribute_annotations { properties { name: "color" value: "blue" confidence: 0.1 } properties { name: "color" value: "white" confidence: 0.2 } properties { name: "material" value: "silk" confidence: 0.3 } } + */ + objectAttributeAnnotations?: Schema$GoogleCloudVisionV1p6beta1EntityAnnotation[]; + /** + * If present, product search has completed successfully. + */ + productSearchResults?: Schema$GoogleCloudVisionV1p6beta1ProductSearchResults; + /** + * If present, image quality optimization has completed successfully. + */ + qualityOptimizationResult?: Schema$GoogleCloudVisionV1p6beta1QualityOptimizationResult; + /** + * If present, safe-search annotation has completed successfully. + */ + safeSearchAnnotation?: Schema$GoogleCloudVisionV1p6beta1SafeSearchAnnotation; + /** + * If present, text (OCR) detection has completed successfully. + */ + textAnnotations?: Schema$GoogleCloudVisionV1p6beta1EntityAnnotation[]; + /** + * If present, web detection has completed successfully. + */ + webDetection?: Schema$GoogleCloudVisionV1p6beta1WebDetection; + } + /** + * The response for a single offline file annotation request. + */ + export interface Schema$GoogleCloudVisionV1p6beta1AsyncAnnotateFileResponse { + /** + * The output location and metadata from AsyncAnnotateFileRequest. + */ + outputConfig?: Schema$GoogleCloudVisionV1p6beta1OutputConfig; + } + /** + * Response to an async batch file annotation request. + */ + export interface Schema$GoogleCloudVisionV1p6beta1AsyncBatchAnnotateFilesResponse { + /** + * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. + */ + responses?: Schema$GoogleCloudVisionV1p6beta1AsyncAnnotateFileResponse[]; + } + /** + * Response to an async batch image annotation request. + */ + export interface Schema$GoogleCloudVisionV1p6beta1AsyncBatchAnnotateImagesResponse { + /** + * The output location and metadata from AsyncBatchAnnotateImagesRequest. + */ + outputConfig?: Schema$GoogleCloudVisionV1p6beta1OutputConfig; + } + /** + * A list of file annotation responses. + */ + export interface Schema$GoogleCloudVisionV1p6beta1BatchAnnotateFilesResponse { + /** + * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. + */ + responses?: Schema$GoogleCloudVisionV1p6beta1AnnotateFileResponse[]; + } + /** + * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. + */ + export interface Schema$GoogleCloudVisionV1p6beta1BatchOperationMetadata { + /** + * The time when the batch request is finished and google.longrunning.Operation.done is set to true. + */ + endTime?: string; + /** + * The current state of the batch operation. + */ + state?: string; + /** + * The time when the batch request was submitted to the server. + */ + submitTime?: string; + } + /** + * Logical element on the page. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Block { + /** + * Detected block type (text, image etc) for this block. + */ + blockType?: string; + /** + * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Confidence of the OCR results on the block. Range [0, 1]. + */ + confidence?: number; + /** + * List of paragraphs in this block (if this blocks is of type text). + */ + paragraphs?: Schema$GoogleCloudVisionV1p6beta1Paragraph[]; + /** + * Additional information detected for the block. + */ + property?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty; + } + /** + * A bounding polygon for the detected image annotation. + */ + export interface Schema$GoogleCloudVisionV1p6beta1BoundingPoly { + /** + * The bounding polygon normalized vertices. + */ + normalizedVertices?: Schema$GoogleCloudVisionV1p6beta1NormalizedVertex[]; + /** + * The bounding polygon vertices. + */ + vertices?: Schema$GoogleCloudVisionV1p6beta1Vertex[]; + } + /** + * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ColorInfo { + /** + * RGB components of the color. + */ + color?: Schema$Color; + /** + * The fraction of pixels the color occupies in the image. Value in range [0, 1]. + */ + pixelFraction?: number; + /** + * Image-specific score for this color. Value in range [0, 1]. + */ + score?: number; + } + /** + * Single crop hint that is used to generate a new crop when serving an image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1CropHint { + /** + * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Confidence of this being a salient region. Range [0, 1]. + */ + confidence?: number; + /** + * Fraction of importance of this salient region with respect to the original image. + */ + importanceFraction?: number; + } + /** + * Set of crop hints that are used to generate new crops when serving images. + */ + export interface Schema$GoogleCloudVisionV1p6beta1CropHintsAnnotation { + /** + * Crop hint results. + */ + cropHints?: Schema$GoogleCloudVisionV1p6beta1CropHint[]; + } + /** + * Set of dominant colors and their corresponding scores. + */ + export interface Schema$GoogleCloudVisionV1p6beta1DominantColorsAnnotation { + /** + * RGB color values with their score and pixel fraction. + */ + colors?: Schema$GoogleCloudVisionV1p6beta1ColorInfo[]; + } + /** + * Set of detected entity features. + */ + export interface Schema$GoogleCloudVisionV1p6beta1EntityAnnotation { + /** + * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. + */ + confidence?: number; + /** + * Entity textual description, expressed in its `locale` language. + */ + description?: string; + /** + * The language code for the locale in which the entity textual `description` is expressed. + */ + locale?: string; + /** + * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. + */ + locations?: Schema$GoogleCloudVisionV1p6beta1LocationInfo[]; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). + */ + mid?: string; + /** + * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. + */ + properties?: Schema$GoogleCloudVisionV1p6beta1Property[]; + /** + * Overall score of the result. Range [0, 1]. + */ + score?: number; + /** + * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. + */ + topicality?: number; + } + /** + * A face annotation object contains the results of face detection. + */ + export interface Schema$GoogleCloudVisionV1p6beta1FaceAnnotation { + /** + * Anger likelihood. + */ + angerLikelihood?: string; + /** + * Blurred likelihood. + */ + blurredLikelihood?: string; + /** + * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Detection confidence. Range [0, 1]. + */ + detectionConfidence?: number; + /** + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. + */ + fdBoundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Headwear likelihood. + */ + headwearLikelihood?: string; + /** + * Joy likelihood. + */ + joyLikelihood?: string; + /** + * Face landmarking confidence. Range [0, 1]. + */ + landmarkingConfidence?: number; + /** + * Detected face landmarks. + */ + landmarks?: Schema$GoogleCloudVisionV1p6beta1FaceAnnotationLandmark[]; + /** + * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. + */ + panAngle?: number; + /** + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. + */ + rollAngle?: number; + /** + * Sorrow likelihood. + */ + sorrowLikelihood?: string; + /** + * Surprise likelihood. + */ + surpriseLikelihood?: string; + /** + * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. + */ + tiltAngle?: number; + /** + * Under-exposed likelihood. + */ + underExposedLikelihood?: string; + } + /** + * A face-specific landmark (for example, a face feature). + */ + export interface Schema$GoogleCloudVisionV1p6beta1FaceAnnotationLandmark { + /** + * Face landmark position. + */ + position?: Schema$GoogleCloudVisionV1p6beta1Position; + /** + * Face landmark type. + */ + type?: string; + } + /** + * The Google Cloud Storage location where the output will be written to. + */ + export interface Schema$GoogleCloudVisionV1p6beta1GcsDestination { + /** + * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. + */ + uri?: string; + } + /** + * The Google Cloud Storage location where the input will be read from. + */ + export interface Schema$GoogleCloudVisionV1p6beta1GcsSource { + /** + * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. + */ + uri?: string; + } + /** + * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ImageAnnotationContext { + /** + * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. + */ + pageNumber?: number; + /** + * The URI of the file used to produce the image. + */ + uri?: string; + } + /** + * Stores image properties, such as dominant colors. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ImageProperties { + /** + * If present, dominant colors completed successfully. + */ + dominantColors?: Schema$GoogleCloudVisionV1p6beta1DominantColorsAnnotation; + } + /** + * Stores image quality scores, could be aesthetic quality or technical quality. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ImageQuality {} + /** + * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ImportProductSetsResponse { + /** + * The list of reference_images that are imported successfully. + */ + referenceImages?: Schema$GoogleCloudVisionV1p6beta1ReferenceImage[]; + /** + * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. + */ + statuses?: Schema$Status[]; + } + /** + * The desired input location and metadata. + */ + export interface Schema$GoogleCloudVisionV1p6beta1InputConfig { + /** + * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. + */ + content?: string; + /** + * The Google Cloud Storage location to read the input from. + */ + gcsSource?: Schema$GoogleCloudVisionV1p6beta1GcsSource; + /** + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. + */ + mimeType?: string; + } + /** + * Set of detected objects with bounding boxes. + */ + export interface Schema$GoogleCloudVisionV1p6beta1LocalizedObjectAnnotation { + /** + * Image region to which this object belongs. This must be populated. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + /** + * Object ID that should align with EntityAnnotation mid. + */ + mid?: string; + /** + * Object name, expressed in its `language_code` language. + */ + name?: string; + /** + * Score of the result. Range [0, 1]. + */ + score?: number; + } + /** + * Detected entity location information. + */ + export interface Schema$GoogleCloudVisionV1p6beta1LocationInfo { + /** + * lat/long location coordinates. + */ + latLng?: Schema$LatLng; + } + /** + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + */ + export interface Schema$GoogleCloudVisionV1p6beta1NormalizedVertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } + /** + * Contains metadata for the BatchAnnotateImages operation. + */ + export interface Schema$GoogleCloudVisionV1p6beta1OperationMetadata { + /** + * The time when the batch request was received. + */ + createTime?: string; + /** + * Current state of the batch operation. + */ + state?: string; + /** + * The time when the operation result was last updated. + */ + updateTime?: string; + } + /** + * The desired output location and metadata. + */ + export interface Schema$GoogleCloudVisionV1p6beta1OutputConfig { + /** + * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. + */ + batchSize?: number; + /** + * The Google Cloud Storage location to write the output(s) to. + */ + gcsDestination?: Schema$GoogleCloudVisionV1p6beta1GcsDestination; + } + /** + * Detected page from OCR. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Page { + /** + * List of blocks of text, images etc on this page. + */ + blocks?: Schema$GoogleCloudVisionV1p6beta1Block[]; + /** + * Confidence of the OCR results on the page. Range [0, 1]. + */ + confidence?: number; + /** + * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. + */ + height?: number; + /** + * Additional information detected on the page. + */ + property?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty; + /** + * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. + */ + width?: number; + } + /** + * Structural unit of text representing a number of words in certain order. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Paragraph { + /** + * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Confidence of the OCR results for the paragraph. Range [0, 1]. + */ + confidence?: number; + /** + * Additional information detected for the paragraph. + */ + property?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty; + /** + * List of words in this paragraph. + */ + words?: Schema$GoogleCloudVisionV1p6beta1Word[]; + } + /** + * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Position { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + /** + * Z coordinate (or depth). + */ + z?: number; + } + /** + * A Product contains ReferenceImages. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Product { + /** + * User-provided metadata to be stored with this product. Must be at most 4096 characters long. + */ + description?: string; + /** + * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. + */ + displayName?: string; + /** + * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. + */ + name?: string; + /** + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + */ + productCategory?: string; + /** + * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 100 product_labels. + */ + productLabels?: Schema$GoogleCloudVisionV1p6beta1ProductKeyValue[]; + } + /** + * A product label represented as a key-value pair. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ProductKeyValue { + /** + * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + key?: string; + /** + * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. + */ + value?: string; + } + /** + * Results for a product search request. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ProductSearchResults { + /** + * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. + */ + indexTime?: string; + /** + * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. + */ + productGroupedResults?: Schema$GoogleCloudVisionV1p6beta1ProductSearchResultsGroupedResult[]; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p6beta1ProductSearchResultsResult[]; + } + /** + * Information about the products similar to a single product in a query image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ProductSearchResultsGroupedResult { + /** + * The bounding polygon around the product detected in the query image. + */ + boundingPoly?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * List of results, one for each product match. + */ + results?: Schema$GoogleCloudVisionV1p6beta1ProductSearchResultsResult[]; + } + /** + * Information about a product. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ProductSearchResultsResult { + /** + * The resource name of the image from the product that is the closest match to the query. + */ + image?: string; + /** + * The Product. + */ + product?: Schema$GoogleCloudVisionV1p6beta1Product; + /** + * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). + */ + score?: number; + } + /** + * A `Property` consists of a user-supplied name/value pair. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Property { + /** + * Value in range [0..1]. Confidence of this property value. + */ + confidence?: number; + /** + * Opaque property value ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). An example property for a blue coat would be: Property { name: 'color' value: 'blue' mid: '/m/01g5v' // For color blue } + */ + mid?: string; + /** + * Name of the property. + */ + name?: string; + /** + * Value of numeric properties. + */ + uint64Value?: string; + /** + * Value of the property. + */ + value?: string; + } + /** + * Stores enhanced image bytes. + */ + export interface Schema$GoogleCloudVisionV1p6beta1QualityOptimizationResult { + /** + * Optimized image bytes. + */ + image?: string; + /** + * Mime type of the output image. + */ + mimeType?: string; + /** + * Required optimization type. + */ + qualityOptimizationType?: string; + } + /** + * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. + */ + export interface Schema$GoogleCloudVisionV1p6beta1ReferenceImage { + /** + * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + */ + boundingPolys?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly[]; + /** + * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. + */ + name?: string; + /** + * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. + */ + uri?: string; + } + /** + * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). + */ + export interface Schema$GoogleCloudVisionV1p6beta1SafeSearchAnnotation { + /** + * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. + */ + adult?: string; + /** + * Likelihood that this is a medical image. + */ + medical?: string; + /** + * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. + */ + racy?: string; + /** + * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. + */ + spoof?: string; + /** + * Likelihood that this image contains violent content. + */ + violence?: string; + } + /** + * A single symbol representation. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Symbol { + /** + * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Confidence of the OCR results for the symbol. Range [0, 1]. + */ + confidence?: number; + /** + * Additional information detected for the symbol. + */ + property?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty; + /** + * The actual UTF-8 representation of the symbol. + */ + text?: string; + } + /** + * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. + */ + export interface Schema$GoogleCloudVisionV1p6beta1TextAnnotation { + /** + * List of pages detected by OCR. + */ + pages?: Schema$GoogleCloudVisionV1p6beta1Page[]; + /** + * UTF-8 text detected on the pages. + */ + text?: string; + } + /** + * Detected start or end of a structural component. + */ + export interface Schema$GoogleCloudVisionV1p6beta1TextAnnotationDetectedBreak { + /** + * True if break prepends the element. + */ + isPrefix?: boolean; + /** + * Detected break type. + */ + type?: string; + } + /** + * Detected language for a structural component. + */ + export interface Schema$GoogleCloudVisionV1p6beta1TextAnnotationDetectedLanguage { + /** + * Confidence of detected language. Range [0, 1]. + */ + confidence?: number; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + } + /** + * Additional information detected on the structural component. + */ + export interface Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty { + /** + * Detected start or end of a text segment. + */ + detectedBreak?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationDetectedBreak; + /** + * A list of detected languages together with confidence. + */ + detectedLanguages?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationDetectedLanguage[]; + } + /** + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Vertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } + /** + * Relevant information for the image from the Internet. + */ + export interface Schema$GoogleCloudVisionV1p6beta1WebDetection { + /** + * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. + */ + bestGuessLabels?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebLabel[]; + /** + * Fully matching images from the Internet. Can include resized copies of the query image. + */ + fullMatchingImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage[]; + /** + * Web pages containing the matching images from the Internet. + */ + pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebPage[]; + /** + * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. + */ + partialMatchingImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage[]; + /** + * The visually similar image results. + */ + visuallySimilarImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage[]; + /** + * Deduced entities from similar images on the Internet. + */ + webEntities?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebEntity[]; + } + /** + * Entity deduced from similar images on the Internet. + */ + export interface Schema$GoogleCloudVisionV1p6beta1WebDetectionWebEntity { + /** + * Canonical description of the entity, in English. + */ + description?: string; + /** + * Opaque entity ID. + */ + entityId?: string; + /** + * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. + */ + score?: number; + } + /** + * Metadata for online images. + */ + export interface Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage { + /** + * (Deprecated) Overall relevancy score for the image. + */ + score?: number; + /** + * The result image URL. + */ + url?: string; + } + /** + * Label to provide extra metadata for the web detection. + */ + export interface Schema$GoogleCloudVisionV1p6beta1WebDetectionWebLabel { + /** + * Label for extra metadata. + */ + label?: string; + /** + * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode?: string; + } + /** + * Metadata for web pages. + */ + export interface Schema$GoogleCloudVisionV1p6beta1WebDetectionWebPage { + /** + * Fully matching images on the page. Can include resized copies of the query image. + */ + fullMatchingImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage[]; + /** + * Title for the web page, may contain HTML markups. + */ + pageTitle?: string; + /** + * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. + */ + partialMatchingImages?: Schema$GoogleCloudVisionV1p6beta1WebDetectionWebImage[]; + /** + * (Deprecated) Overall relevancy score for the web page. + */ + score?: number; + /** + * The result web page URL. + */ + url?: string; + } + /** + * A word representation. + */ + export interface Schema$GoogleCloudVisionV1p6beta1Word { + /** + * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). + */ + boundingBox?: Schema$GoogleCloudVisionV1p6beta1BoundingPoly; + /** + * Confidence of the OCR results for the word. Range [0, 1]. + */ + confidence?: number; + /** + * Additional information detected for the word. + */ + property?: Schema$GoogleCloudVisionV1p6beta1TextAnnotationTextProperty; + /** + * List of symbols in the word. The order of the symbols follows the natural reading order. + */ + symbols?: Schema$GoogleCloudVisionV1p6beta1Symbol[]; + } /** * Information about the products similar to a single product in a query image. */ @@ -5243,7 +6182,7 @@ export namespace vision_v1p2beta1 { */ gcsSource?: Schema$GcsSource; /** - * The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported. + * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string; } @@ -5468,7 +6407,7 @@ export namespace vision_v1p2beta1 { */ name?: string; /** - * The category for the product identified by the reference image. This should be either "homegoods", "apparel", or "toys". This field is immutable. + * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. */ productCategory?: string; /** @@ -5570,7 +6509,7 @@ export namespace vision_v1p2beta1 { violence?: string; } /** - * 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. + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** diff --git a/src/apis/vision/webpack.config.js b/src/apis/vision/webpack.config.js index 4cafde9656f..68b33dd2274 100644 --- a/src/apis/vision/webpack.config.js +++ b/src/apis/vision/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/webfonts/package.json b/src/apis/webfonts/package.json index 09e7f098b0c..272df82d94d 100644 --- a/src/apis/webfonts/package.json +++ b/src/apis/webfonts/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/webfonts/webpack.config.js b/src/apis/webfonts/webpack.config.js index 80a158dfd86..83f516295f6 100644 --- a/src/apis/webfonts/webpack.config.js +++ b/src/apis/webfonts/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/webmasters/package.json b/src/apis/webmasters/package.json index 6194418583b..653d742b998 100644 --- a/src/apis/webmasters/package.json +++ b/src/apis/webmasters/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/webmasters/webpack.config.js b/src/apis/webmasters/webpack.config.js index 9f33e387bfc..b760c5f39cc 100644 --- a/src/apis/webmasters/webpack.config.js +++ b/src/apis/webmasters/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/websecurityscanner/index.ts b/src/apis/websecurityscanner/index.ts index 448f249573f..78f88887661 100644 --- a/src/apis/websecurityscanner/index.ts +++ b/src/apis/websecurityscanner/index.ts @@ -14,14 +14,22 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {websecurityscanner_v1} from './v1'; import {websecurityscanner_v1alpha} from './v1alpha'; import {websecurityscanner_v1beta} from './v1beta'; export const VERSIONS = { + v1: websecurityscanner_v1.Websecurityscanner, v1alpha: websecurityscanner_v1alpha.Websecurityscanner, v1beta: websecurityscanner_v1beta.Websecurityscanner, }; +export function websecurityscanner( + version: 'v1' +): websecurityscanner_v1.Websecurityscanner; +export function websecurityscanner( + options: websecurityscanner_v1.Options +): websecurityscanner_v1.Websecurityscanner; export function websecurityscanner( version: 'v1alpha' ): websecurityscanner_v1alpha.Websecurityscanner; @@ -36,11 +44,14 @@ export function websecurityscanner( ): websecurityscanner_v1beta.Websecurityscanner; export function websecurityscanner< T = + | websecurityscanner_v1.Websecurityscanner | websecurityscanner_v1alpha.Websecurityscanner | websecurityscanner_v1beta.Websecurityscanner >( this: GoogleConfigurable, versionOrOptions: + | 'v1' + | websecurityscanner_v1.Options | 'v1alpha' | websecurityscanner_v1alpha.Options | 'v1beta' diff --git a/src/apis/websecurityscanner/package.json b/src/apis/websecurityscanner/package.json index 679552e36d3..1a17662789a 100644 --- a/src/apis/websecurityscanner/package.json +++ b/src/apis/websecurityscanner/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/websecurityscanner/v1.ts b/src/apis/websecurityscanner/v1.ts new file mode 100644 index 00000000000..d8e7749bd6f --- /dev/null +++ b/src/apis/websecurityscanner/v1.ts @@ -0,0 +1,116 @@ +/** + * Copyright 2019 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. + */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace websecurityscanner_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Web Security Scanner API + * + * Scans your Compute and App Engine apps for common web vulnerabilities. + * + * @example + * const {google} = require('googleapis'); + * const websecurityscanner = google.websecurityscanner('v1'); + * + * @namespace websecurityscanner + * @type {Function} + * @version v1 + * @variation v1 + * @param {object=} options Options for Websecurityscanner + */ + export class Websecurityscanner { + context: APIRequestContext; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + } + } +} diff --git a/src/apis/websecurityscanner/v1alpha.ts b/src/apis/websecurityscanner/v1alpha.ts index bdf0fc8543d..d0a35ddb315 100644 --- a/src/apis/websecurityscanner/v1alpha.ts +++ b/src/apis/websecurityscanner/v1alpha.ts @@ -156,7 +156,7 @@ export namespace websecurityscanner_v1alpha { */ loginUrl?: string; /** - * Input only. Required. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. + * Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. */ password?: string; /** @@ -251,7 +251,7 @@ export namespace websecurityscanner_v1alpha { */ export interface Schema$GoogleAccount { /** - * Input only. Required. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. + * Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. */ password?: string; /** diff --git a/src/apis/websecurityscanner/v1beta.ts b/src/apis/websecurityscanner/v1beta.ts index ea850000fef..03cc5197878 100644 --- a/src/apis/websecurityscanner/v1beta.ts +++ b/src/apis/websecurityscanner/v1beta.ts @@ -156,7 +156,7 @@ export namespace websecurityscanner_v1beta { */ loginUrl?: string; /** - * Input only. Required. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. + * Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs. */ password?: string; /** @@ -268,7 +268,7 @@ export namespace websecurityscanner_v1beta { */ export interface Schema$GoogleAccount { /** - * Input only. Required. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. + * Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs. */ password?: string; /** @@ -368,7 +368,7 @@ export namespace websecurityscanner_v1beta { version?: string; } /** - * A ScanConfig resource contains the configurations to launch a scan. next id: 12 + * A ScanConfig resource contains the configurations to launch a scan. */ export interface Schema$ScanConfig { /** @@ -399,6 +399,10 @@ export namespace websecurityscanner_v1beta { * The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. */ name?: string; + /** + * The risk level selected for the scan + */ + riskLevel?: string; /** * The schedule of the ScanConfig. */ diff --git a/src/apis/websecurityscanner/webpack.config.js b/src/apis/websecurityscanner/webpack.config.js index 2f843699dc6..0145579ac49 100644 --- a/src/apis/websecurityscanner/webpack.config.js +++ b/src/apis/websecurityscanner/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/youtube/package.json b/src/apis/youtube/package.json index ba5d5789d13..7b78352bc27 100644 --- a/src/apis/youtube/package.json +++ b/src/apis/youtube/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/youtube/webpack.config.js b/src/apis/youtube/webpack.config.js index 7727170bbb7..58aa291af1f 100644 --- a/src/apis/youtube/webpack.config.js +++ b/src/apis/youtube/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/youtubeAnalytics/index.ts b/src/apis/youtubeAnalytics/index.ts index ca4b77c4b77..f2b44d14f63 100644 --- a/src/apis/youtubeAnalytics/index.ts +++ b/src/apis/youtubeAnalytics/index.ts @@ -15,12 +15,10 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {youtubeAnalytics_v1} from './v1'; -import {youtubeAnalytics_v1beta1} from './v1beta1'; import {youtubeAnalytics_v2} from './v2'; export const VERSIONS = { v1: youtubeAnalytics_v1.Youtubeanalytics, - v1beta1: youtubeAnalytics_v1beta1.Youtubeanalytics, v2: youtubeAnalytics_v2.Youtubeanalytics, }; @@ -30,12 +28,6 @@ export function youtubeAnalytics( export function youtubeAnalytics( options: youtubeAnalytics_v1.Options ): youtubeAnalytics_v1.Youtubeanalytics; -export function youtubeAnalytics( - version: 'v1beta1' -): youtubeAnalytics_v1beta1.Youtubeanalytics; -export function youtubeAnalytics( - options: youtubeAnalytics_v1beta1.Options -): youtubeAnalytics_v1beta1.Youtubeanalytics; export function youtubeAnalytics( version: 'v2' ): youtubeAnalytics_v2.Youtubeanalytics; @@ -45,15 +37,12 @@ export function youtubeAnalytics( export function youtubeAnalytics< T = | youtubeAnalytics_v1.Youtubeanalytics - | youtubeAnalytics_v1beta1.Youtubeanalytics | youtubeAnalytics_v2.Youtubeanalytics >( this: GoogleConfigurable, versionOrOptions: | 'v1' | youtubeAnalytics_v1.Options - | 'v1beta1' - | youtubeAnalytics_v1beta1.Options | 'v2' | youtubeAnalytics_v2.Options ) { diff --git a/src/apis/youtubeAnalytics/package.json b/src/apis/youtubeAnalytics/package.json index 273ec6ac3e4..3030598df4b 100644 --- a/src/apis/youtubeAnalytics/package.json +++ b/src/apis/youtubeAnalytics/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/youtubeAnalytics/v1.ts b/src/apis/youtubeAnalytics/v1.ts index eaf16740936..363c5f20046 100644 --- a/src/apis/youtubeAnalytics/v1.ts +++ b/src/apis/youtubeAnalytics/v1.ts @@ -43,9 +43,21 @@ export namespace youtubeAnalytics_v1 { interface StandardParameters { /** - * Data format for the response. + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. */ alt?: string; + /** + * JSONP + */ + callback?: string; /** * Selector specifying which fields to include in a partial response. */ @@ -63,13 +75,17 @@ export namespace youtubeAnalytics_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** - * Deprecated. Please use quotaUser instead. + * Legacy upload protocol for media (e.g. "media", "multipart"). */ - userIp?: string; + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; } /** @@ -89,864 +105,12 @@ export namespace youtubeAnalytics_v1 { */ export class Youtubeanalytics { context: APIRequestContext; - groupItems: Resource$Groupitems; - groups: Resource$Groups; - reports: Resource$Reports; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { _options: options || {}, google, }; - - this.groupItems = new Resource$Groupitems(this.context); - this.groups = new Resource$Groups(this.context); - this.reports = new Resource$Reports(this.context); - } - } - - export interface Schema$Group { - contentDetails?: {itemCount?: string; itemType?: string}; - etag?: string; - id?: string; - kind?: string; - snippet?: {publishedAt?: string; title?: string}; - } - export interface Schema$GroupItem { - etag?: string; - groupId?: string; - id?: string; - kind?: string; - resource?: {id?: string; kind?: string}; - } - /** - * A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request. - */ - export interface Schema$GroupItemListResponse { - etag?: string; - items?: Schema$GroupItem[]; - kind?: string; - } - /** - * A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request. - */ - export interface Schema$GroupListResponse { - etag?: string; - items?: Schema$Group[]; - kind?: string; - nextPageToken?: string; - } - /** - * Contains a single result table. The table is returned as an array of rows that contain the values for the cells of the table. Depending on the metric or dimension, the cell can contain a string (video ID, country code) or a number (number of views or number of likes). - */ - export interface Schema$ResultTable { - /** - * This value specifies information about the data returned in the rows fields. Each item in the columnHeaders list identifies a field returned in the rows value, which contains a list of comma-delimited data. The columnHeaders list will begin with the dimensions specified in the API request, which will be followed by the metrics specified in the API request. The order of both dimensions and metrics will match the ordering in the API request. For example, if the API request contains the parameters dimensions=ageGroup,gender&metrics=viewerPercentage, the API response will return columns in this order: ageGroup,gender,viewerPercentage. - */ - columnHeaders?: Array<{ - columnType?: string; - dataType?: string; - name?: string; - }>; - /** - * This value specifies the type of data included in the API response. For the query method, the kind property value will be youtubeAnalytics#resultTable. - */ - kind?: string; - /** - * The list contains all rows of the result table. Each item in the list is an array that contains comma-delimited data corresponding to a single row of data. The order of the comma-delimited data fields will match the order of the columns listed in the columnHeaders field. If no data is available for the given query, the rows element will be omitted from the response. The response for a query with the day dimension will not contain rows for the most recent days. - */ - rows?: any[][]; - } - - export class Resource$Groupitems { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * youtubeAnalytics.groupItems.delete - * @desc Removes an item from a group. - * @alias youtubeAnalytics.groupItems.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id The id parameter specifies the YouTube group item ID for the group that is being deleted. - * @param {string=} params.onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - * @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$Groupitems$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Groupitems$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Groupitems$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Groupitems$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Groupitems$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Groupitems$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/youtube/analytics/v1/groupItems').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['id'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * youtubeAnalytics.groupItems.insert - * @desc Creates a group item. - * @alias youtubeAnalytics.groupItems.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - * @param {().GroupItem} 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$Groupitems$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Groupitems$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Groupitems$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Groupitems$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Groupitems$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Groupitems$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/youtube/analytics/v1/groupItems').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * youtubeAnalytics.groupItems.list - * @desc Returns a collection of group items that match the API request parameters. - * @alias youtubeAnalytics.groupItems.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.groupId The id parameter specifies the unique ID of the group for which you want to retrieve group items. - * @param {string=} params.onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - * @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$Groupitems$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Groupitems$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Groupitems$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Groupitems$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Groupitems$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Groupitems$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/youtube/analytics/v1/groupItems').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['groupId'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } } } - - export interface Params$Resource$Groupitems$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The id parameter specifies the YouTube group item ID for the group that is being deleted. - */ - id?: string; - /** - * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - */ - onBehalfOfContentOwner?: string; - } - export interface Params$Resource$Groupitems$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - */ - onBehalfOfContentOwner?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GroupItem; - } - export interface Params$Resource$Groupitems$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The id parameter specifies the unique ID of the group for which you want to retrieve group items. - */ - groupId?: string; - /** - * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - */ - onBehalfOfContentOwner?: string; - } - - export class Resource$Groups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * youtubeAnalytics.groups.delete - * @desc Deletes a group. - * @alias youtubeAnalytics.groups.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id The id parameter specifies the YouTube group ID for the group that is being deleted. - * @param {string=} params.onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - * @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$Groups$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Groups$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Groups$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Groups$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Groups$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Groups$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/youtube/analytics/v1/groups').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['id'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * youtubeAnalytics.groups.insert - * @desc Creates a group. - * @alias youtubeAnalytics.groups.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - * @param {().Group} 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$Groups$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Groups$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Groups$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Groups$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Groups$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Groups$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/youtube/analytics/v1/groups').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * youtubeAnalytics.groups.list - * @desc Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs. - * @alias youtubeAnalytics.groups.list - * @memberOf! () - * - * @param {object=} params Parameters for request - * @param {string=} params.id The id parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. In a group resource, the id property specifies the group's YouTube group ID. - * @param {boolean=} params.mine Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user. - * @param {string=} params.onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - * @param {string=} params.pageToken The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page that can be retrieved. - * @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$Groups$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Groups$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Groups$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Groups$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Groups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Groups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/youtube/analytics/v1/groups').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * youtubeAnalytics.groups.update - * @desc Modifies a group. For example, you could change a group's title. - * @alias youtubeAnalytics.groups.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - * @param {().Group} 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 - */ - update( - params?: Params$Resource$Groups$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Groups$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Groups$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Groups$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Groups$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Groups$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/youtube/analytics/v1/groups').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'PUT', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Groups$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The id parameter specifies the YouTube group ID for the group that is being deleted. - */ - id?: string; - /** - * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - */ - onBehalfOfContentOwner?: string; - } - export interface Params$Resource$Groups$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - */ - onBehalfOfContentOwner?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Group; - } - export interface Params$Resource$Groups$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The id parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. In a group resource, the id property specifies the group's YouTube group ID. - */ - id?: string; - /** - * Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user. - */ - mine?: boolean; - /** - * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - */ - onBehalfOfContentOwner?: string; - /** - * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page that can be retrieved. - */ - pageToken?: string; - } - export interface Params$Resource$Groups$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - */ - onBehalfOfContentOwner?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Group; - } - - export class Resource$Reports { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * youtubeAnalytics.reports.query - * @desc Retrieve your YouTube Analytics reports. - * @alias youtubeAnalytics.reports.query - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.currency The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized. - * @param {string=} params.dimensions A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender. See the Available Reports document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the Dimensions document for definitions of those dimensions. - * @param {string} params.end-date The end date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. - * @param {string=} params.filters A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports document identifies the dimensions that can be used to filter each report, and the Dimensions document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (;), and the returned result table will satisfy both filters. For example, a filters parameter value of video==dMH0bHeiRNg;country==IT restricts the result set to include data for the given video in Italy. - * @param {string} params.ids Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data. - To request data for a YouTube user, set the ids parameter value to channel==CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the ids parameter value to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content owner. - * @param {boolean=} params.include-historical-channel-data If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved. - * @param {integer=} params.max-results The maximum number of rows to include in the response. - * @param {string} params.metrics A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes. See the Available Reports document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics document for definitions of those metrics. - * @param {string=} params.sort A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '-' prefix causes descending sort order. - * @param {string} params.start-date The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive). - * @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 - */ - query( - params?: Params$Resource$Reports$Query, - options?: MethodOptions - ): GaxiosPromise; - query( - params: Params$Resource$Reports$Query, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - query( - params: Params$Resource$Reports$Query, - callback: BodyResponseCallback - ): void; - query(callback: BodyResponseCallback): void; - query( - paramsOrCallback?: - | Params$Resource$Reports$Query - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Query; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Query; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/youtube/analytics/v1/reports').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['ids', 'start-date', 'end-date', 'metrics'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Reports$Query extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized. - */ - currency?: string; - /** - * A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender. See the Available Reports document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the Dimensions document for definitions of those dimensions. - */ - dimensions?: string; - /** - * The end date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. - */ - 'end-date'?: string; - /** - * A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports document identifies the dimensions that can be used to filter each report, and the Dimensions document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (;), and the returned result table will satisfy both filters. For example, a filters parameter value of video==dMH0bHeiRNg;country==IT restricts the result set to include data for the given video in Italy. - */ - filters?: string; - /** - * Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data. - To request data for a YouTube user, set the ids parameter value to channel==CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the ids parameter value to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content owner. - */ - ids?: string; - /** - * If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved. - */ - 'include-historical-channel-data'?: boolean; - /** - * The maximum number of rows to include in the response. - */ - 'max-results'?: number; - /** - * A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes. See the Available Reports document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics document for definitions of those metrics. - */ - metrics?: string; - /** - * A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '-' prefix causes descending sort order. - */ - sort?: string; - /** - * The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. - */ - 'start-date'?: string; - /** - * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive). - */ - 'start-index'?: number; - } } diff --git a/src/apis/youtubeAnalytics/v1beta1.ts b/src/apis/youtubeAnalytics/v1beta1.ts deleted file mode 100644 index a6670790170..00000000000 --- a/src/apis/youtubeAnalytics/v1beta1.ts +++ /dev/null @@ -1,952 +0,0 @@ -/** - * Copyright 2019 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. - */ - -import { - OAuth2Client, - JWT, - Compute, - UserRefreshClient, -} from 'google-auth-library'; -import { - GoogleConfigurable, - createAPIRequest, - MethodOptions, - GlobalOptions, - BodyResponseCallback, - APIRequestContext, -} from 'googleapis-common'; -import {GaxiosPromise} from 'gaxios'; - -// tslint:disable: no-any -// tslint:disable: class-name -// tslint:disable: variable-name -// tslint:disable: jsdoc-format -// tslint:disable: no-namespace - -export namespace youtubeAnalytics_v1beta1 { - export interface Options extends GlobalOptions { - version: 'v1beta1'; - } - - interface StandardParameters { - /** - * Data format for the response. - */ - alt?: string; - /** - * Selector specifying which fields to include in a partial response. - */ - fields?: string; - /** - * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - */ - key?: string; - /** - * OAuth 2.0 token for the current user. - */ - oauth_token?: string; - /** - * Returns response with indentations and line breaks. - */ - prettyPrint?: boolean; - /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - */ - quotaUser?: string; - /** - * Deprecated. Please use quotaUser instead. - */ - userIp?: string; - } - - /** - * YouTube Analytics API - * - * Retrieves your YouTube Analytics data. - * - * @example - * const {google} = require('googleapis'); - * const youtubeAnalytics = google.youtubeAnalytics('v1beta1'); - * - * @namespace youtubeAnalytics - * @type {Function} - * @version v1beta1 - * @variation v1beta1 - * @param {object=} options Options for Youtubeanalytics - */ - export class Youtubeanalytics { - context: APIRequestContext; - groupItems: Resource$Groupitems; - groups: Resource$Groups; - reports: Resource$Reports; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.groupItems = new Resource$Groupitems(this.context); - this.groups = new Resource$Groups(this.context); - this.reports = new Resource$Reports(this.context); - } - } - - export interface Schema$Group { - contentDetails?: {itemCount?: string; itemType?: string}; - etag?: string; - id?: string; - kind?: string; - snippet?: {publishedAt?: string; title?: string}; - } - export interface Schema$GroupItem { - etag?: string; - groupId?: string; - id?: string; - kind?: string; - resource?: {id?: string; kind?: string}; - } - /** - * A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request. - */ - export interface Schema$GroupItemListResponse { - etag?: string; - items?: Schema$GroupItem[]; - kind?: string; - } - /** - * A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request. - */ - export interface Schema$GroupListResponse { - etag?: string; - items?: Schema$Group[]; - kind?: string; - nextPageToken?: string; - } - /** - * Contains a single result table. The table is returned as an array of rows that contain the values for the cells of the table. Depending on the metric or dimension, the cell can contain a string (video ID, country code) or a number (number of views or number of likes). - */ - export interface Schema$ResultTable { - /** - * This value specifies information about the data returned in the rows fields. Each item in the columnHeaders list identifies a field returned in the rows value, which contains a list of comma-delimited data. The columnHeaders list will begin with the dimensions specified in the API request, which will be followed by the metrics specified in the API request. The order of both dimensions and metrics will match the ordering in the API request. For example, if the API request contains the parameters dimensions=ageGroup,gender&metrics=viewerPercentage, the API response will return columns in this order: ageGroup,gender,viewerPercentage. - */ - columnHeaders?: Array<{ - columnType?: string; - dataType?: string; - name?: string; - }>; - /** - * This value specifies the type of data included in the API response. For the query method, the kind property value will be youtubeAnalytics#resultTable. - */ - kind?: string; - /** - * The list contains all rows of the result table. Each item in the list is an array that contains comma-delimited data corresponding to a single row of data. The order of the comma-delimited data fields will match the order of the columns listed in the columnHeaders field. If no data is available for the given query, the rows element will be omitted from the response. The response for a query with the day dimension will not contain rows for the most recent days. - */ - rows?: any[][]; - } - - export class Resource$Groupitems { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * youtubeAnalytics.groupItems.delete - * @desc Removes an item from a group. - * @alias youtubeAnalytics.groupItems.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id The id parameter specifies the YouTube group item ID for the group that is being deleted. - * @param {string=} params.onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - * @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$Groupitems$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Groupitems$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Groupitems$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Groupitems$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Groupitems$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Groupitems$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/youtube/analytics/v1beta1/groupItems').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['id'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * youtubeAnalytics.groupItems.insert - * @desc Creates a group item. - * @alias youtubeAnalytics.groupItems.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - * @param {().GroupItem} 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$Groupitems$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Groupitems$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Groupitems$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Groupitems$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Groupitems$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Groupitems$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/youtube/analytics/v1beta1/groupItems').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * youtubeAnalytics.groupItems.list - * @desc Returns a collection of group items that match the API request parameters. - * @alias youtubeAnalytics.groupItems.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.groupId The id parameter specifies the unique ID of the group for which you want to retrieve group items. - * @param {string=} params.onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - * @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$Groupitems$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Groupitems$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Groupitems$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Groupitems$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Groupitems$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Groupitems$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/youtube/analytics/v1beta1/groupItems').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['groupId'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Groupitems$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The id parameter specifies the YouTube group item ID for the group that is being deleted. - */ - id?: string; - /** - * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - */ - onBehalfOfContentOwner?: string; - } - export interface Params$Resource$Groupitems$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - */ - onBehalfOfContentOwner?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GroupItem; - } - export interface Params$Resource$Groupitems$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The id parameter specifies the unique ID of the group for which you want to retrieve group items. - */ - groupId?: string; - /** - * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - */ - onBehalfOfContentOwner?: string; - } - - export class Resource$Groups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * youtubeAnalytics.groups.delete - * @desc Deletes a group. - * @alias youtubeAnalytics.groups.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id The id parameter specifies the YouTube group ID for the group that is being deleted. - * @param {string=} params.onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - * @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$Groups$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Groups$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Groups$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Groups$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Groups$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Groups$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/youtube/analytics/v1beta1/groups').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['id'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * youtubeAnalytics.groups.insert - * @desc Creates a group. - * @alias youtubeAnalytics.groups.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - * @param {().Group} 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$Groups$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Groups$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Groups$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Groups$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Groups$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Groups$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/youtube/analytics/v1beta1/groups').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * youtubeAnalytics.groups.list - * @desc Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs. - * @alias youtubeAnalytics.groups.list - * @memberOf! () - * - * @param {object=} params Parameters for request - * @param {string=} params.id The id parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. In a group resource, the id property specifies the group's YouTube group ID. - * @param {boolean=} params.mine Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user. - * @param {string=} params.onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - * @param {string=} params.pageToken The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page that can be retrieved. - * @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$Groups$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Groups$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Groups$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Groups$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Groups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Groups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/youtube/analytics/v1beta1/groups').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * youtubeAnalytics.groups.update - * @desc Modifies a group. For example, you could change a group's title. - * @alias youtubeAnalytics.groups.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.onBehalfOfContentOwner Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - * @param {().Group} 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 - */ - update( - params?: Params$Resource$Groups$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Groups$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Groups$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Groups$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Groups$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Groups$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/youtube/analytics/v1beta1/groups').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'PUT', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Groups$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The id parameter specifies the YouTube group ID for the group that is being deleted. - */ - id?: string; - /** - * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - */ - onBehalfOfContentOwner?: string; - } - export interface Params$Resource$Groups$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - */ - onBehalfOfContentOwner?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Group; - } - export interface Params$Resource$Groups$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The id parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. In a group resource, the id property specifies the group's YouTube group ID. - */ - id?: string; - /** - * Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user. - */ - mine?: boolean; - /** - * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - */ - onBehalfOfContentOwner?: string; - /** - * The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page that can be retrieved. - */ - pageToken?: string; - } - export interface Params$Resource$Groups$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. - */ - onBehalfOfContentOwner?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Group; - } - - export class Resource$Reports { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * youtubeAnalytics.reports.query - * @desc Retrieve your YouTube Analytics reports. - * @alias youtubeAnalytics.reports.query - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.currency The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized. - * @param {string=} params.dimensions A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender. See the Available Reports document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the Dimensions document for definitions of those dimensions. - * @param {string} params.end-date The end date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. - * @param {string=} params.filters A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports document identifies the dimensions that can be used to filter each report, and the Dimensions document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (;), and the returned result table will satisfy both filters. For example, a filters parameter value of video==dMH0bHeiRNg;country==IT restricts the result set to include data for the given video in Italy. - * @param {string} params.ids Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data. - To request data for a YouTube user, set the ids parameter value to channel==CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the ids parameter value to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content owner. - * @param {boolean=} params.include-historical-channel-data If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved. - * @param {integer=} params.max-results The maximum number of rows to include in the response. - * @param {string} params.metrics A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes. See the Available Reports document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics document for definitions of those metrics. - * @param {string=} params.sort A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '-' prefix causes descending sort order. - * @param {string} params.start-date The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive). - * @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 - */ - query( - params?: Params$Resource$Reports$Query, - options?: MethodOptions - ): GaxiosPromise; - query( - params: Params$Resource$Reports$Query, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - query( - params: Params$Resource$Reports$Query, - callback: BodyResponseCallback - ): void; - query(callback: BodyResponseCallback): void; - query( - paramsOrCallback?: - | Params$Resource$Reports$Query - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Query; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Query; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/youtube/analytics/v1beta1/reports').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['ids', 'start-date', 'end-date', 'metrics'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Reports$Query extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized. - */ - currency?: string; - /** - * A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender. See the Available Reports document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the Dimensions document for definitions of those dimensions. - */ - dimensions?: string; - /** - * The end date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. - */ - 'end-date'?: string; - /** - * A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports document identifies the dimensions that can be used to filter each report, and the Dimensions document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (;), and the returned result table will satisfy both filters. For example, a filters parameter value of video==dMH0bHeiRNg;country==IT restricts the result set to include data for the given video in Italy. - */ - filters?: string; - /** - * Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data. - To request data for a YouTube user, set the ids parameter value to channel==CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the ids parameter value to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content owner. - */ - ids?: string; - /** - * If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved. - */ - 'include-historical-channel-data'?: boolean; - /** - * The maximum number of rows to include in the response. - */ - 'max-results'?: number; - /** - * A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes. See the Available Reports document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics document for definitions of those metrics. - */ - metrics?: string; - /** - * A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '-' prefix causes descending sort order. - */ - sort?: string; - /** - * The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. - */ - 'start-date'?: string; - /** - * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive). - */ - 'start-index'?: number; - } -} diff --git a/src/apis/youtubeAnalytics/webpack.config.js b/src/apis/youtubeAnalytics/webpack.config.js index 1f37e07eaf1..714cfc6aeba 100644 --- a/src/apis/youtubeAnalytics/webpack.config.js +++ b/src/apis/youtubeAnalytics/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/apis/youtubereporting/package.json b/src/apis/youtubereporting/package.json index a33e575b066..a172aeb9e09 100644 --- a/src/apis/youtubereporting/package.json +++ b/src/apis/youtubereporting/package.json @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", "null-loader": "^3.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.5.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/apis/youtubereporting/webpack.config.js b/src/apis/youtubereporting/webpack.config.js index 8da0b2d69db..e4ffe6291fd 100644 --- a/src/apis/youtubereporting/webpack.config.js +++ b/src/apis/youtubereporting/webpack.config.js @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules\/https-proxy-agent\//, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gcp-metadata\//, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules\/gtoken\//, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules\/pkginfo\//, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules\/semver\//, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/generator/templates/package.json.njk b/src/generator/templates/package.json.njk index 39146520e5a..a7a74318ab3 100644 --- a/src/generator/templates/package.json.njk +++ b/src/generator/templates/package.json.njk @@ -29,15 +29,15 @@ "webpack": "webpack" }, "dependencies": { - "googleapis-common": "^2.0.0" + "googleapis-common": "^2.0.4" }, "devDependencies": { "gts": "^1.0.0", - "null-loader": "^1.0.0", - "ts-loader": "^6.0.0", - "typedoc": "^0.14.0", - "typescript": "~3.4.0", - "webpack": "^4.28.4", - "webpack-cli": "^3.2.1" + "null-loader": "^3.0.0", + "ts-loader": "^6.0.4", + "typedoc": "^0.15.0", + "typescript": "~3.5.3", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" } } diff --git a/src/generator/templates/webpack.config.js.njk b/src/generator/templates/webpack.config.js.njk index 3051608f165..32b06dd1525 100644 --- a/src/generator/templates/webpack.config.js.njk +++ b/src/generator/templates/webpack.config.js.njk @@ -36,27 +36,27 @@ module.exports = { module: { rules: [ { - test: /node_modules[\\\/]google-auth-library[\\\/]src[\\\/]crypto[\\\/]node[\\\/]crypto/, + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, use: 'null-loader', }, { - test: /node_modules[\\\/]https-proxy-agent[\\\/]/, + test: /node_modules[\\/]https-proxy-agent[\\/]/, use: 'null-loader', }, { - test: /node_modules[\\\/]gcp-metadata[\\\/]/, + test: /node_modules[\\/]gcp-metadata[\\/]/, use: 'null-loader', }, { - test: /node_modules[\\\/]gtoken[\\\/]/, + test: /node_modules[\\/]gtoken[\\/]/, use: 'null-loader', }, { - test: /node_modules[\\\/]pkginfo[\\\/]/, + test: /node_modules[\\/]pkginfo[\\/]/, use: 'null-loader', }, { - test: /node_modules[\\\/]semver[\\\/]/, + test: /node_modules[\\/]semver[\\/]/, use: 'null-loader', }, { diff --git a/src/index.ts b/src/index.ts index dc516525639..dfcd4cda0e7 100644 --- a/src/index.ts +++ b/src/index.ts @@ -142,8 +142,10 @@ export {drive_v2} from './apis/drive/v2'; export {drive_v3} from './apis/drive/v3'; export {driveactivity_v2} from './apis/driveactivity/v2'; export {factchecktools_v1alpha1} from './apis/factchecktools/v1alpha1'; +export {fcm_v1} from './apis/fcm/v1'; export {file_v1} from './apis/file/v1'; export {file_v1beta1} from './apis/file/v1beta1'; +export {firebase_v1beta1} from './apis/firebase/v1beta1'; export {firebasedynamiclinks_v1} from './apis/firebasedynamiclinks/v1'; export {firebasehosting_v1beta1} from './apis/firebasehosting/v1beta1'; export {firebaserules_v1} from './apis/firebaserules/v1'; @@ -217,6 +219,7 @@ export {replicapool_v1beta1} from './apis/replicapool/v1beta1'; export {reseller_v1} from './apis/reseller/v1'; export {run_v1} from './apis/run/v1'; export {run_v1alpha1} from './apis/run/v1alpha1'; +export {run_v1beta1} from './apis/run/v1beta1'; export {runtimeconfig_v1} from './apis/runtimeconfig/v1'; export {runtimeconfig_v1beta1} from './apis/runtimeconfig/v1beta1'; export {safebrowsing_v4} from './apis/safebrowsing/v4'; @@ -224,6 +227,7 @@ export {script_v1} from './apis/script/v1'; export {searchconsole_v1} from './apis/searchconsole/v1'; export {securitycenter_v1} from './apis/securitycenter/v1'; export {securitycenter_v1beta1} from './apis/securitycenter/v1beta1'; +export {securitycenter_v1p1alpha1} from './apis/securitycenter/v1p1alpha1'; export {servicebroker_v1} from './apis/servicebroker/v1'; export {servicebroker_v1alpha1} from './apis/servicebroker/v1alpha1'; export {servicebroker_v1beta1} from './apis/servicebroker/v1beta1'; @@ -272,10 +276,10 @@ export {vision_v1p1beta1} from './apis/vision/v1p1beta1'; export {vision_v1p2beta1} from './apis/vision/v1p2beta1'; export {webfonts_v1} from './apis/webfonts/v1'; export {webmasters_v3} from './apis/webmasters/v3'; +export {websecurityscanner_v1} from './apis/websecurityscanner/v1'; export {websecurityscanner_v1alpha} from './apis/websecurityscanner/v1alpha'; export {websecurityscanner_v1beta} from './apis/websecurityscanner/v1beta'; export {youtube_v3} from './apis/youtube/v3'; export {youtubeAnalytics_v1} from './apis/youtubeAnalytics/v1'; -export {youtubeAnalytics_v1beta1} from './apis/youtubeAnalytics/v1beta1'; export {youtubeAnalytics_v2} from './apis/youtubeAnalytics/v2'; export {youtubereporting_v1} from './apis/youtubereporting/v1';