From 6d5a9c8aa7ef2f602ac53b8e1cb9ce65eddb4f35 Mon Sep 17 00:00:00 2001 From: Justin Beckwith Date: Tue, 23 Apr 2019 23:12:50 -0700 Subject: [PATCH] feat: run the generator (#1680) --- src/apis/accessapproval/README.md | 47 + src/apis/accessapproval/index.ts | 34 + src/apis/accessapproval/package.json | 43 + src/apis/accessapproval/tsconfig.json | 10 + src/apis/accessapproval/v1beta1.ts | 1949 ++++ src/apis/accessapproval/webpack.config.js | 71 + src/apis/adexchangebuyer2/v2beta1.ts | 102 - src/apis/alertcenter/v1beta1.ts | 68 +- src/apis/androiddeviceprovisioning/v1.ts | 28 + src/apis/androidmanagement/v1.ts | 53 + src/apis/androidpublisher/v2.ts | 25 +- src/apis/androidpublisher/v3.ts | 25 +- src/apis/appengine/v1.ts | 7 +- src/apis/appengine/v1beta.ts | 7 +- src/apis/bigquery/v2.ts | 926 +- src/apis/bigtableadmin/v2.ts | 16 +- src/apis/binaryauthorization/v1beta1.ts | 2 +- src/apis/cloudbilling/v1.ts | 7 +- src/apis/cloudbuild/v1alpha1.ts | 2 +- src/apis/cloudfunctions/v1.ts | 12 +- src/apis/cloudfunctions/v1beta2.ts | 8 +- src/apis/cloudiot/v1.ts | 2 +- .../cloudprivatecatalogproducer/v1beta1.ts | 2 +- src/apis/cloudresourcemanager/v1.ts | 2 +- src/apis/cloudresourcemanager/v1beta1.ts | 2 +- src/apis/cloudresourcemanager/v2.ts | 2 +- src/apis/cloudresourcemanager/v2beta1.ts | 2 +- src/apis/cloudscheduler/index.ts | 12 +- src/apis/cloudscheduler/v1.ts | 1508 +++ src/apis/cloudsearch/v1.ts | 137 +- src/apis/cloudtasks/v2.ts | 2 +- src/apis/cloudtasks/v2beta2.ts | 2 +- src/apis/cloudtasks/v2beta3.ts | 2 +- src/apis/commentanalyzer/README.md | 47 + src/apis/commentanalyzer/index.ts | 34 + src/apis/commentanalyzer/package.json | 43 + src/apis/commentanalyzer/tsconfig.json | 10 + src/apis/commentanalyzer/v1alpha1.ts | 574 ++ src/apis/commentanalyzer/webpack.config.js | 71 + src/apis/compute/alpha.ts | 1440 ++- src/apis/compute/beta.ts | 107 +- src/apis/compute/v1.ts | 41 +- src/apis/container/v1.ts | 336 +- src/apis/container/v1beta1.ts | 136 +- src/apis/dns/v1.ts | 674 +- src/apis/dns/v1beta2.ts | 868 +- src/apis/dns/v2beta1.ts | 674 +- src/apis/docs/v1.ts | 5 +- src/apis/drive/v2.ts | 1467 ++- src/apis/drive/v3.ts | 1421 ++- src/apis/driveactivity/v2.ts | 107 +- src/apis/file/v1.ts | 224 + src/apis/file/v1beta1.ts | 224 + src/apis/firebasehosting/v1beta1.ts | 16 +- src/apis/firebaserules/v1.ts | 7 +- src/apis/firestore/v1.ts | 2 +- src/apis/firestore/v1beta1.ts | 2 +- src/apis/fitness/v1.ts | 2 +- src/apis/healthcare/v1alpha.ts | 8576 ++--------------- src/apis/healthcare/v1alpha2.ts | 6 +- src/apis/healthcare/v1beta1.ts | 6 +- src/apis/iap/v1.ts | 2 +- src/apis/iap/v1beta1.ts | 2 +- src/apis/index.ts | 6 + src/apis/jobs/v3.ts | 16 +- src/apis/jobs/v3p1beta1.ts | 16 +- src/apis/language/v1.ts | 7 +- src/apis/language/v1beta2.ts | 7 +- src/apis/logging/index.ts | 11 +- src/apis/logging/v2beta1.ts | 3301 ------- src/apis/ml/v1.ts | 72 +- src/apis/people/v1.ts | 35 +- src/apis/plusDomains/v1.ts | 94 - src/apis/poly/v1.ts | 2 +- src/apis/pubsub/v1.ts | 7 +- src/apis/pubsub/v1beta2.ts | 7 +- src/apis/run/v1alpha1.ts | 2 +- src/apis/runtimeconfig/v1beta1.ts | 2 +- src/apis/securitycenter/v1.ts | 39 +- src/apis/securitycenter/v1beta1.ts | 26 + src/apis/servicebroker/v1.ts | 2 +- src/apis/servicebroker/v1alpha1.ts | 2 +- src/apis/servicebroker/v1beta1.ts | 2 +- src/apis/serviceconsumermanagement/v1.ts | 165 +- src/apis/servicemanagement/v1.ts | 8 +- src/apis/servicenetworking/v1.ts | 2 +- src/apis/servicenetworking/v1beta.ts | 2 +- src/apis/serviceusage/v1.ts | 60 +- src/apis/serviceusage/v1beta1.ts | 60 +- src/apis/sourcerepo/v1.ts | 7 +- src/apis/spanner/v1.ts | 12 +- src/apis/sqladmin/v1beta4.ts | 4 + src/apis/storage/v1.ts | 536 ++ src/apis/toolresults/v1beta3.ts | 293 + src/apis/vault/v1.ts | 15 +- src/apis/vision/v1.ts | 349 +- src/apis/vision/v1p1beta1.ts | 163 +- src/apis/vision/v1p2beta1.ts | 163 +- src/index.ts | 4 +- 99 files changed, 13685 insertions(+), 14055 deletions(-) create mode 100644 src/apis/accessapproval/README.md create mode 100644 src/apis/accessapproval/index.ts create mode 100644 src/apis/accessapproval/package.json create mode 100644 src/apis/accessapproval/tsconfig.json create mode 100644 src/apis/accessapproval/v1beta1.ts create mode 100644 src/apis/accessapproval/webpack.config.js create mode 100644 src/apis/cloudscheduler/v1.ts create mode 100644 src/apis/commentanalyzer/README.md create mode 100644 src/apis/commentanalyzer/index.ts create mode 100644 src/apis/commentanalyzer/package.json create mode 100644 src/apis/commentanalyzer/tsconfig.json create mode 100644 src/apis/commentanalyzer/v1alpha1.ts create mode 100644 src/apis/commentanalyzer/webpack.config.js delete mode 100644 src/apis/logging/v2beta1.ts diff --git a/src/apis/accessapproval/README.md b/src/apis/accessapproval/README.md new file mode 100644 index 00000000000..7f654d85564 --- /dev/null +++ b/src/apis/accessapproval/README.md @@ -0,0 +1,47 @@ +Google Inc. logo + +# accessapproval + +> An API for controlling access to data by Google personnel. + +## 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/accessapproval +$ npm install +$ npm run webpack +``` + +The generated bundle will be written to `dist/accessapproval.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/accessapproval/index.ts b/src/apis/accessapproval/index.ts new file mode 100644 index 00000000000..45feda217e4 --- /dev/null +++ b/src/apis/accessapproval/index.ts @@ -0,0 +1,34 @@ +// 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 {accessapproval_v1beta1} from './v1beta1'; + +export const VERSIONS = { + 'v1beta1': accessapproval_v1beta1.Accessapproval, +}; + +export function accessapproval(version: 'v1beta1'): + accessapproval_v1beta1.Accessapproval; +export function accessapproval(options: accessapproval_v1beta1.Options): + accessapproval_v1beta1.Accessapproval; +export function accessapproval( + this: GoogleConfigurable, + versionOrOptions: 'v1beta1'|accessapproval_v1beta1.Options) { + return getAPI('accessapproval', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; diff --git a/src/apis/accessapproval/package.json b/src/apis/accessapproval/package.json new file mode 100644 index 00000000000..eebb986921d --- /dev/null +++ b/src/apis/accessapproval/package.json @@ -0,0 +1,43 @@ +{ + "name": "@google/accessapproval", + "version": "0.1.0", + "description": "accessapproval", + "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": ">=6.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": "^0.7.0" + }, + "devDependencies": { + "gts": "^0.9.0", + "null-loader": "^0.1.1", + "ts-loader": "^5.3.3", + "typedoc": "^0.14.0", + "typescript": "~3.4.0", + "webpack": "^4.28.4", + "webpack-cli": "^3.2.1" + } +} diff --git a/src/apis/accessapproval/tsconfig.json b/src/apis/accessapproval/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/accessapproval/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/accessapproval/v1beta1.ts b/src/apis/accessapproval/v1beta1.ts new file mode 100644 index 00000000000..e9bb893b1eb --- /dev/null +++ b/src/apis/accessapproval/v1beta1.ts @@ -0,0 +1,1949 @@ +/** + * 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 {GaxiosPromise} from 'gaxios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; +import {APIRequestContext, BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace accessapproval_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; + } + + /** + * Access Approval API + * + * An API for controlling access to data by Google personnel. + * + * @example + * const {google} = require('googleapis'); + * const accessapproval = google.accessapproval('v1beta1'); + * + * @namespace accessapproval + * @type {Function} + * @version v1beta1 + * @variation v1beta1 + * @param {object=} options Options for Accessapproval + */ + export class Accessapproval { + context: APIRequestContext; + folders: Resource$Folders; + organizations: Resource$Organizations; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = {_options: options || {}, google}; + + this.folders = new Resource$Folders(this.context); + this.organizations = new Resource$Organizations(this.context); + this.projects = new Resource$Projects(this.context); + } + } + + /** + * Settings on a Project/Folder/Organization related to Access Approval. + */ + export interface Schema$AccessApprovalSettings { + /** + * The resource name of the settings. Format is one of: <ol> + * <li>"projects/{project_id}/accessApprovalSettings"</li> + * <li>"folders/{folder_id}/accessApprovalSettings"</li> + * <li>"organizations/{organization_id}/accessApprovalSettings"</li> + * <ol> + */ + name?: string; + /** + * A list of email addresses to which notifications relating to approval + * requests should be sent. Notifications relating to a resource will be + * sent to all emails in the settings of ancestor resources of that + * resource. + */ + notificationEmails?: string[]; + } + /** + * Home office and physical location of the principal. + */ + export interface Schema$AccessLocations { + /** + * The "home office" location of the principal. A two-letter + * country code (ISO 3166-1 alpha-2), such as "US", "DE" + * or "GB" or a region code. In some limited situations Google + * systems may refer refer to a region code instead of a country code. + * Possible Region Codes: <ol> <li>ASI: Asia</li> + * <li>EUR: Europe</li> <li>OCE: Oceania</li> + * <li>AFR: Africa</li> <li>NAM: North + * America</li> <li>SAM: South America</li> + * <li>ANT: Antarctica</li> <li>ANY: Any + * location</li> </ol> + */ + principalOfficeCountry?: string; + /** + * Physical location of the principal at the time of the access. A + * two-letter country code (ISO 3166-1 alpha-2), such as "US", + * "DE" or "GB" or a region code. In some limited + * situations Google systems may refer refer to a region code instead of a + * country code. Possible Region Codes: <ol> <li>ASI: + * Asia</li> <li>EUR: Europe</li> <li>OCE: + * Oceania</li> <li>AFR: Africa</li> <li>NAM: + * North America</li> <li>SAM: South America</li> + * <li>ANT: Antarctica</li> <li>ANY: Any + * location</li> </ol> + */ + principalPhysicalLocationCountry?: string; + } + export interface Schema$AccessReason { + /** + * More detail about certain reason types. See comments for each type above. + */ + detail?: string; + /** + * Type of access justification. + */ + type?: string; + } + /** + * A request for the customer to approve access to a resource. + */ + export interface Schema$ApprovalRequest { + /** + * Access was approved. + */ + approve?: Schema$ApproveDecision; + /** + * The request was dismissed. + */ + dismiss?: Schema$DismissDecision; + /** + * The resource name of the request. Format is + * "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}". + */ + name?: string; + /** + * The requested expiration for the approval. If the request is approved, + * access will be granted from the time of approval until the expiration + * time. + */ + requestedExpiration?: string; + /** + * The locations for which approval is being requested. + */ + requestedLocations?: Schema$AccessLocations; + /** + * The justification for which approval is being requested. + */ + requestedReason?: Schema$AccessReason; + /** + * The resource for which approval is being requested. The format of the + * resource name is defined at + * https://cloud.google.com/apis/design/resource_names. The resource name + * here may either be a "full" resource name (e.g. + * "//library.googleapis.com/shelves/shelf1/books/book2") or a + * "relative" resource name (e.g. + * "shelves/shelf1/books/book2") as described in the resource name + * specification. + */ + requestedResourceName?: string; + /** + * The time at which approval was requested. + */ + requestTime?: string; + } + /** + * Request to approve an ApprovalRequest. + */ + export interface Schema$ApproveApprovalRequestMessage { + /** + * The expiration time of this approval. + */ + expireTime?: string; + } + /** + * A decision that has been made to approve access to a resource. + */ + export interface Schema$ApproveDecision { + /** + * The time at which approval was granted. + */ + approveTime?: string; + /** + * The time at which the approval expires. + */ + expireTime?: string; + } + /** + * Request to dismiss an approval request. + */ + export interface Schema$DismissApprovalRequestMessage {} + /** + * A decision that has been made to dismiss an approval request. + */ + export interface Schema$DismissDecision { + /** + * The time at which the approval request was dismissed. + */ + dismissTime?: string; + } + /** + * Response to listing of ApprovalRequest objects. + */ + export interface Schema$ListApprovalRequestsResponse { + /** + * Approval request details. + */ + approvalRequests?: Schema$ApprovalRequest[]; + /** + * Token to retrieve the next page of results, or empty if there are no + * more. + */ + nextPageToken?: string; + } + + + export class Resource$Folders { + context: APIRequestContext; + approvalRequests: Resource$Folders$Approvalrequests; + constructor(context: APIRequestContext) { + this.context = context; + this.approvalRequests = + new Resource$Folders$Approvalrequests(this.context); + } + + + /** + * accessapproval.folders.getAccessApprovalSettings + * @desc Gets the settings associated with a project, folder, or + * organization. + * @alias accessapproval.folders.getAccessApprovalSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the AccessApprovalSettings 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 + */ + getAccessApprovalSettings( + params?: Params$Resource$Folders$Getaccessapprovalsettings, + options?: MethodOptions): GaxiosPromise; + getAccessApprovalSettings( + params: Params$Resource$Folders$Getaccessapprovalsettings, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + getAccessApprovalSettings( + params: Params$Resource$Folders$Getaccessapprovalsettings, + callback: BodyResponseCallback): void; + getAccessApprovalSettings( + callback: BodyResponseCallback): void; + getAccessApprovalSettings( + paramsOrCallback?: Params$Resource$Folders$Getaccessapprovalsettings| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Folders$Getaccessapprovalsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Getaccessapprovalsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.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); + } + } + + + /** + * accessapproval.folders.updateAccessApprovalSettings + * @desc Updates the settings associated with a project, folder, or + * organization. Completely replaces the existing settings. + * @alias accessapproval.folders.updateAccessApprovalSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the settings. Format is one of:
  1. "projects/{project_id}/accessApprovalSettings"
  2. "folders/{folder_id}/accessApprovalSettings"
  3. "organizations/{organization_id}/accessApprovalSettings"
      4. + * @param {().AccessApprovalSettings} 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 + */ + updateAccessApprovalSettings( + params?: Params$Resource$Folders$Updateaccessapprovalsettings, + options?: MethodOptions): GaxiosPromise; + updateAccessApprovalSettings( + params: Params$Resource$Folders$Updateaccessapprovalsettings, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + updateAccessApprovalSettings( + params: Params$Resource$Folders$Updateaccessapprovalsettings, + callback: BodyResponseCallback): void; + updateAccessApprovalSettings( + callback: BodyResponseCallback): void; + updateAccessApprovalSettings( + paramsOrCallback?: Params$Resource$Folders$Updateaccessapprovalsettings| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Folders$Updateaccessapprovalsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Updateaccessapprovalsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.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$Folders$Getaccessapprovalsettings extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the AccessApprovalSettings to retrieve. + */ + name?: string; + } + export interface Params$Resource$Folders$Updateaccessapprovalsettings extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the settings. Format is one of:
        + *
      1. "projects/{project_id}/accessApprovalSettings"
        2. + *
      2. "folders/{folder_id}/accessApprovalSettings"
        3. + *
      3. "organizations/{organization_id}/accessApprovalSettings"
          4. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccessApprovalSettings; + } + + export class Resource$Folders$Approvalrequests { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + + /** + * accessapproval.folders.approvalRequests.approve + * @desc Approves a request and returns the updated ApprovalRequest. Returns + * NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if + * the request exists but is not in a pending state. + * @alias accessapproval.folders.approvalRequests.approve + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the approval request to approve. + * @param {().ApproveApprovalRequestMessage} 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 + */ + approve( + params?: Params$Resource$Folders$Approvalrequests$Approve, + options?: MethodOptions): GaxiosPromise; + approve( + params: Params$Resource$Folders$Approvalrequests$Approve, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + approve( + params: Params$Resource$Folders$Approvalrequests$Approve, + callback: BodyResponseCallback): void; + approve(callback: BodyResponseCallback): void; + approve( + paramsOrCallback?: Params$Resource$Folders$Approvalrequests$Approve| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Folders$Approvalrequests$Approve; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Approvalrequests$Approve; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:approve') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * accessapproval.folders.approvalRequests.dismiss + * @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE: + * This does not deny access to the resource if another request has been + * made and approved. It is equivalent in effect to ignoring the request + * altogether. Returns NOT_FOUND if the request does not exist. Returns + * FAILED_PRECONDITION if the request exists but is not in a pending state. + * @alias accessapproval.folders.approvalRequests.dismiss + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the ApprovalRequest to dismiss. + * @param {().DismissApprovalRequestMessage} 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 + */ + dismiss( + params?: Params$Resource$Folders$Approvalrequests$Dismiss, + options?: MethodOptions): GaxiosPromise; + dismiss( + params: Params$Resource$Folders$Approvalrequests$Dismiss, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + dismiss( + params: Params$Resource$Folders$Approvalrequests$Dismiss, + callback: BodyResponseCallback): void; + dismiss(callback: BodyResponseCallback): void; + dismiss( + paramsOrCallback?: Params$Resource$Folders$Approvalrequests$Dismiss| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Folders$Approvalrequests$Dismiss; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Approvalrequests$Dismiss; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:dismiss') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * accessapproval.folders.approvalRequests.get + * @desc Gets an approval request. Returns NOT_FOUND if the request does not + * exist. + * @alias accessapproval.folders.approvalRequests.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the approval request 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$Folders$Approvalrequests$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Folders$Approvalrequests$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Folders$Approvalrequests$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Folders$Approvalrequests$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Folders$Approvalrequests$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Approvalrequests$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.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); + } + } + + + /** + * accessapproval.folders.approvalRequests.list + * @desc Lists approval requests associated with a project, folder, or + * organization. Approval requests can be filtered by state (pending, + * active, dismissed). The order is reverse chronological. + * @alias accessapproval.folders.approvalRequests.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter on the type of approval requests to retrieve. Must be one of the following values:
          1. [not set]: Requests that are pending or have active approvals.
          2. ALL: All requests.
          3. PENDING: Only pending requests.
          4. ACTIVE: Only active (i.e. currently approved) requests.
          5. DISMISSED: Only dismissed (including expired) requests.
          + * @param {integer=} params.pageSize Requested page size. + * @param {string=} params.pageToken A token identifying the page of results to return. + * @param {string} params.parent The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{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 + */ + list( + params?: Params$Resource$Folders$Approvalrequests$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Folders$Approvalrequests$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Folders$Approvalrequests$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Folders$Approvalrequests$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Folders$Approvalrequests$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Approvalrequests$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/approvalRequests') + .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$Folders$Approvalrequests$Approve extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the approval request to approve. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ApproveApprovalRequestMessage; + } + export interface Params$Resource$Folders$Approvalrequests$Dismiss extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the ApprovalRequest to dismiss. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DismissApprovalRequestMessage; + } + export interface Params$Resource$Folders$Approvalrequests$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the approval request to retrieve. + */ + name?: string; + } + export interface Params$Resource$Folders$Approvalrequests$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter on the type of approval requests to retrieve. Must be one of the + * following values:
          1. [not set]: Requests that are pending or have + * active approvals.
          2. ALL: All requests.
          3. PENDING: Only + * pending requests.
          4. ACTIVE: Only active (i.e. currently + * approved) requests.
          5. DISMISSED: Only dismissed (including + * expired) requests.
          + */ + filter?: string; + /** + * Requested page size. + */ + pageSize?: number; + /** + * A token identifying the page of results to return. + */ + pageToken?: string; + /** + * The parent resource. This may be "projects/{project_id}", + * "folders/{folder_id}", or "organizations/{organization_id}". + */ + parent?: string; + } + + + + export class Resource$Organizations { + context: APIRequestContext; + approvalRequests: Resource$Organizations$Approvalrequests; + constructor(context: APIRequestContext) { + this.context = context; + this.approvalRequests = + new Resource$Organizations$Approvalrequests(this.context); + } + + + /** + * accessapproval.organizations.getAccessApprovalSettings + * @desc Gets the settings associated with a project, folder, or + * organization. + * @alias accessapproval.organizations.getAccessApprovalSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the AccessApprovalSettings 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 + */ + getAccessApprovalSettings( + params?: Params$Resource$Organizations$Getaccessapprovalsettings, + options?: MethodOptions): GaxiosPromise; + getAccessApprovalSettings( + params: Params$Resource$Organizations$Getaccessapprovalsettings, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + getAccessApprovalSettings( + params: Params$Resource$Organizations$Getaccessapprovalsettings, + callback: BodyResponseCallback): void; + getAccessApprovalSettings( + callback: BodyResponseCallback): void; + getAccessApprovalSettings( + paramsOrCallback?: + Params$Resource$Organizations$Getaccessapprovalsettings| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Organizations$Getaccessapprovalsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Getaccessapprovalsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.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); + } + } + + + /** + * accessapproval.organizations.updateAccessApprovalSettings + * @desc Updates the settings associated with a project, folder, or + * organization. Completely replaces the existing settings. + * @alias accessapproval.organizations.updateAccessApprovalSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the settings. Format is one of:
          1. "projects/{project_id}/accessApprovalSettings"
          2. "folders/{folder_id}/accessApprovalSettings"
          3. "organizations/{organization_id}/accessApprovalSettings"
              4. + * @param {().AccessApprovalSettings} 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 + */ + updateAccessApprovalSettings( + params?: Params$Resource$Organizations$Updateaccessapprovalsettings, + options?: MethodOptions): GaxiosPromise; + updateAccessApprovalSettings( + params: Params$Resource$Organizations$Updateaccessapprovalsettings, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + updateAccessApprovalSettings( + params: Params$Resource$Organizations$Updateaccessapprovalsettings, + callback: BodyResponseCallback): void; + updateAccessApprovalSettings( + callback: BodyResponseCallback): void; + updateAccessApprovalSettings( + paramsOrCallback?: + Params$Resource$Organizations$Updateaccessapprovalsettings| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Organizations$Updateaccessapprovalsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Organizations$Updateaccessapprovalsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.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$Organizations$Getaccessapprovalsettings + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the AccessApprovalSettings to retrieve. + */ + name?: string; + } + export interface Params$Resource$Organizations$Updateaccessapprovalsettings + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the settings. Format is one of:
                + *
              1. "projects/{project_id}/accessApprovalSettings"
                2. + *
              2. "folders/{folder_id}/accessApprovalSettings"
                3. + *
              3. "organizations/{organization_id}/accessApprovalSettings"
                  4. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccessApprovalSettings; + } + + export class Resource$Organizations$Approvalrequests { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + + /** + * accessapproval.organizations.approvalRequests.approve + * @desc Approves a request and returns the updated ApprovalRequest. Returns + * NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if + * the request exists but is not in a pending state. + * @alias accessapproval.organizations.approvalRequests.approve + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the approval request to approve. + * @param {().ApproveApprovalRequestMessage} 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 + */ + approve( + params?: Params$Resource$Organizations$Approvalrequests$Approve, + options?: MethodOptions): GaxiosPromise; + approve( + params: Params$Resource$Organizations$Approvalrequests$Approve, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + approve( + params: Params$Resource$Organizations$Approvalrequests$Approve, + callback: BodyResponseCallback): void; + approve(callback: BodyResponseCallback): void; + approve( + paramsOrCallback?: + Params$Resource$Organizations$Approvalrequests$Approve| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Organizations$Approvalrequests$Approve; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Approvalrequests$Approve; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:approve') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * accessapproval.organizations.approvalRequests.dismiss + * @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE: + * This does not deny access to the resource if another request has been + * made and approved. It is equivalent in effect to ignoring the request + * altogether. Returns NOT_FOUND if the request does not exist. Returns + * FAILED_PRECONDITION if the request exists but is not in a pending state. + * @alias accessapproval.organizations.approvalRequests.dismiss + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the ApprovalRequest to dismiss. + * @param {().DismissApprovalRequestMessage} 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 + */ + dismiss( + params?: Params$Resource$Organizations$Approvalrequests$Dismiss, + options?: MethodOptions): GaxiosPromise; + dismiss( + params: Params$Resource$Organizations$Approvalrequests$Dismiss, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + dismiss( + params: Params$Resource$Organizations$Approvalrequests$Dismiss, + callback: BodyResponseCallback): void; + dismiss(callback: BodyResponseCallback): void; + dismiss( + paramsOrCallback?: + Params$Resource$Organizations$Approvalrequests$Dismiss| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Organizations$Approvalrequests$Dismiss; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Approvalrequests$Dismiss; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:dismiss') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * accessapproval.organizations.approvalRequests.get + * @desc Gets an approval request. Returns NOT_FOUND if the request does not + * exist. + * @alias accessapproval.organizations.approvalRequests.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the approval request 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$Organizations$Approvalrequests$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Organizations$Approvalrequests$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Organizations$Approvalrequests$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Organizations$Approvalrequests$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Organizations$Approvalrequests$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Approvalrequests$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.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); + } + } + + + /** + * accessapproval.organizations.approvalRequests.list + * @desc Lists approval requests associated with a project, folder, or + * organization. Approval requests can be filtered by state (pending, + * active, dismissed). The order is reverse chronological. + * @alias accessapproval.organizations.approvalRequests.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter on the type of approval requests to retrieve. Must be one of the following values:
                  1. [not set]: Requests that are pending or have active approvals.
                  2. ALL: All requests.
                  3. PENDING: Only pending requests.
                  4. ACTIVE: Only active (i.e. currently approved) requests.
                  5. DISMISSED: Only dismissed (including expired) requests.
                  + * @param {integer=} params.pageSize Requested page size. + * @param {string=} params.pageToken A token identifying the page of results to return. + * @param {string} params.parent The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{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 + */ + list( + params?: Params$Resource$Organizations$Approvalrequests$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Organizations$Approvalrequests$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Organizations$Approvalrequests$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Organizations$Approvalrequests$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Organizations$Approvalrequests$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Approvalrequests$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/approvalRequests') + .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$Organizations$Approvalrequests$Approve + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the approval request to approve. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ApproveApprovalRequestMessage; + } + export interface Params$Resource$Organizations$Approvalrequests$Dismiss + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the ApprovalRequest to dismiss. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DismissApprovalRequestMessage; + } + export interface Params$Resource$Organizations$Approvalrequests$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the approval request to retrieve. + */ + name?: string; + } + export interface Params$Resource$Organizations$Approvalrequests$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter on the type of approval requests to retrieve. Must be one of the + * following values:
                  1. [not set]: Requests that are pending or have + * active approvals.
                  2. ALL: All requests.
                  3. PENDING: Only + * pending requests.
                  4. ACTIVE: Only active (i.e. currently + * approved) requests.
                  5. DISMISSED: Only dismissed (including + * expired) requests.
                  + */ + filter?: string; + /** + * Requested page size. + */ + pageSize?: number; + /** + * A token identifying the page of results to return. + */ + pageToken?: string; + /** + * The parent resource. This may be "projects/{project_id}", + * "folders/{folder_id}", or "organizations/{organization_id}". + */ + parent?: string; + } + + + + export class Resource$Projects { + context: APIRequestContext; + approvalRequests: Resource$Projects$Approvalrequests; + constructor(context: APIRequestContext) { + this.context = context; + this.approvalRequests = + new Resource$Projects$Approvalrequests(this.context); + } + + + /** + * accessapproval.projects.getAccessApprovalSettings + * @desc Gets the settings associated with a project, folder, or + * organization. + * @alias accessapproval.projects.getAccessApprovalSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the AccessApprovalSettings 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 + */ + getAccessApprovalSettings( + params?: Params$Resource$Projects$Getaccessapprovalsettings, + options?: MethodOptions): GaxiosPromise; + getAccessApprovalSettings( + params: Params$Resource$Projects$Getaccessapprovalsettings, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + getAccessApprovalSettings( + params: Params$Resource$Projects$Getaccessapprovalsettings, + callback: BodyResponseCallback): void; + getAccessApprovalSettings( + callback: BodyResponseCallback): void; + getAccessApprovalSettings( + paramsOrCallback?: Params$Resource$Projects$Getaccessapprovalsettings| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Getaccessapprovalsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Getaccessapprovalsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.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); + } + } + + + /** + * accessapproval.projects.updateAccessApprovalSettings + * @desc Updates the settings associated with a project, folder, or + * organization. Completely replaces the existing settings. + * @alias accessapproval.projects.updateAccessApprovalSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the settings. Format is one of:
                  1. "projects/{project_id}/accessApprovalSettings"
                  2. "folders/{folder_id}/accessApprovalSettings"
                  3. "organizations/{organization_id}/accessApprovalSettings"
                      4. + * @param {().AccessApprovalSettings} 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 + */ + updateAccessApprovalSettings( + params?: Params$Resource$Projects$Updateaccessapprovalsettings, + options?: MethodOptions): GaxiosPromise; + updateAccessApprovalSettings( + params: Params$Resource$Projects$Updateaccessapprovalsettings, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + updateAccessApprovalSettings( + params: Params$Resource$Projects$Updateaccessapprovalsettings, + callback: BodyResponseCallback): void; + updateAccessApprovalSettings( + callback: BodyResponseCallback): void; + updateAccessApprovalSettings( + paramsOrCallback?: + Params$Resource$Projects$Updateaccessapprovalsettings| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Updateaccessapprovalsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Updateaccessapprovalsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.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$Getaccessapprovalsettings extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the AccessApprovalSettings to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Updateaccessapprovalsettings extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the settings. Format is one of:
                        + *
                      1. "projects/{project_id}/accessApprovalSettings"
                        2. + *
                      2. "folders/{folder_id}/accessApprovalSettings"
                        3. + *
                      3. "organizations/{organization_id}/accessApprovalSettings"
                          4. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccessApprovalSettings; + } + + export class Resource$Projects$Approvalrequests { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + + /** + * accessapproval.projects.approvalRequests.approve + * @desc Approves a request and returns the updated ApprovalRequest. Returns + * NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if + * the request exists but is not in a pending state. + * @alias accessapproval.projects.approvalRequests.approve + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the approval request to approve. + * @param {().ApproveApprovalRequestMessage} 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 + */ + approve( + params?: Params$Resource$Projects$Approvalrequests$Approve, + options?: MethodOptions): GaxiosPromise; + approve( + params: Params$Resource$Projects$Approvalrequests$Approve, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + approve( + params: Params$Resource$Projects$Approvalrequests$Approve, + callback: BodyResponseCallback): void; + approve(callback: BodyResponseCallback): void; + approve( + paramsOrCallback?: Params$Resource$Projects$Approvalrequests$Approve| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Approvalrequests$Approve; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Approvalrequests$Approve; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:approve') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * accessapproval.projects.approvalRequests.dismiss + * @desc Dismisses a request. Returns the updated ApprovalRequest. NOTE: + * This does not deny access to the resource if another request has been + * made and approved. It is equivalent in effect to ignoring the request + * altogether. Returns NOT_FOUND if the request does not exist. Returns + * FAILED_PRECONDITION if the request exists but is not in a pending state. + * @alias accessapproval.projects.approvalRequests.dismiss + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the ApprovalRequest to dismiss. + * @param {().DismissApprovalRequestMessage} 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 + */ + dismiss( + params?: Params$Resource$Projects$Approvalrequests$Dismiss, + options?: MethodOptions): GaxiosPromise; + dismiss( + params: Params$Resource$Projects$Approvalrequests$Dismiss, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + dismiss( + params: Params$Resource$Projects$Approvalrequests$Dismiss, + callback: BodyResponseCallback): void; + dismiss(callback: BodyResponseCallback): void; + dismiss( + paramsOrCallback?: Params$Resource$Projects$Approvalrequests$Dismiss| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Approvalrequests$Dismiss; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Approvalrequests$Dismiss; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:dismiss') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * accessapproval.projects.approvalRequests.get + * @desc Gets an approval request. Returns NOT_FOUND if the request does not + * exist. + * @alias accessapproval.projects.approvalRequests.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the approval request 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$Projects$Approvalrequests$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Projects$Approvalrequests$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Approvalrequests$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Projects$Approvalrequests$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Approvalrequests$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Approvalrequests$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.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); + } + } + + + /** + * accessapproval.projects.approvalRequests.list + * @desc Lists approval requests associated with a project, folder, or + * organization. Approval requests can be filtered by state (pending, + * active, dismissed). The order is reverse chronological. + * @alias accessapproval.projects.approvalRequests.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter on the type of approval requests to retrieve. Must be one of the following values:
                          1. [not set]: Requests that are pending or have active approvals.
                          2. ALL: All requests.
                          3. PENDING: Only pending requests.
                          4. ACTIVE: Only active (i.e. currently approved) requests.
                          5. DISMISSED: Only dismissed (including expired) requests.
                          + * @param {integer=} params.pageSize Requested page size. + * @param {string=} params.pageToken A token identifying the page of results to return. + * @param {string} params.parent The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", or "organizations/{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 + */ + list( + params?: Params$Resource$Projects$Approvalrequests$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Projects$Approvalrequests$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Projects$Approvalrequests$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Projects$Approvalrequests$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Approvalrequests$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Approvalrequests$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/approvalRequests') + .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$Approvalrequests$Approve extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the approval request to approve. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ApproveApprovalRequestMessage; + } + export interface Params$Resource$Projects$Approvalrequests$Dismiss extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the ApprovalRequest to dismiss. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DismissApprovalRequestMessage; + } + export interface Params$Resource$Projects$Approvalrequests$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the approval request to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Approvalrequests$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter on the type of approval requests to retrieve. Must be one of the + * following values:
                          1. [not set]: Requests that are pending or have + * active approvals.
                          2. ALL: All requests.
                          3. PENDING: Only + * pending requests.
                          4. ACTIVE: Only active (i.e. currently + * approved) requests.
                          5. DISMISSED: Only dismissed (including + * expired) requests.
                          + */ + filter?: string; + /** + * Requested page size. + */ + pageSize?: number; + /** + * A token identifying the page of results to return. + */ + pageToken?: string; + /** + * The parent resource. This may be "projects/{project_id}", + * "folders/{folder_id}", or "organizations/{organization_id}". + */ + parent?: string; + } +} diff --git a/src/apis/accessapproval/webpack.config.js b/src/apis/accessapproval/webpack.config.js new file mode 100644 index 00000000000..a612f5ce6f6 --- /dev/null +++ b/src/apis/accessapproval/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: 'Accessapproval', + filename: 'accessapproval.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/adexchangebuyer2/v2beta1.ts b/src/apis/adexchangebuyer2/v2beta1.ts index d2214ff97be..f1c4c591c7c 100644 --- a/src/apis/adexchangebuyer2/v2beta1.ts +++ b/src/apis/adexchangebuyer2/v2beta1.ts @@ -5881,116 +5881,14 @@ export namespace adexchangebuyer2_v2beta1 { export class Resource$Bidders$Accounts { context: APIRequestContext; - creatives: Resource$Bidders$Accounts$Creatives; filterSets: Resource$Bidders$Accounts$Filtersets; constructor(context: APIRequestContext) { this.context = context; - this.creatives = new Resource$Bidders$Accounts$Creatives(this.context); this.filterSets = new Resource$Bidders$Accounts$Filtersets(this.context); } } - export class Resource$Bidders$Accounts$Creatives { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - - /** - * adexchangebuyer2.bidders.accounts.creatives.delete - * @desc Deletes a single creative. A creative is deactivated upon deletion - * and does not count against active snippet quota. A deleted creative - * should not be used in bidding (all bids with that creative will be - * rejected). - * @alias adexchangebuyer2.bidders.accounts.creatives.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeId The ID of the creative to delete. - * @param {string} params.ownerName Name of the owner (bidder or account) of the creative to be deleted. For example: - For an account-level creative for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level creative for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` - * @param {object} [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$Bidders$Accounts$Creatives$Delete, - options?: MethodOptions): GaxiosPromise; - delete( - params: Params$Resource$Bidders$Accounts$Creatives$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Bidders$Accounts$Creatives$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Bidders$Accounts$Creatives$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Bidders$Accounts$Creatives$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Bidders$Accounts$Creatives$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://adexchangebuyer.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+ownerName}/creatives/{creativeId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['ownerName', 'creativeId'], - pathParams: ['creativeId', 'ownerName'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Bidders$Accounts$Creatives$Delete extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the creative to delete. - */ - creativeId?: string; - /** - * Name of the owner (bidder or account) of the creative to be deleted. For - * example: - For an account-level creative for the buyer account - * representing bidder 123: `bidders/123/accounts/123` - For an - * account-level creative for the child seat buyer account 456 whose - * bidder is 123: `bidders/123/accounts/456` - */ - ownerName?: string; - } - - export class Resource$Bidders$Accounts$Filtersets { context: APIRequestContext; bidMetrics: Resource$Bidders$Accounts$Filtersets$Bidmetrics; diff --git a/src/apis/alertcenter/v1beta1.ts b/src/apis/alertcenter/v1beta1.ts index 1c1e43e4cf1..aa436af107f 100644 --- a/src/apis/alertcenter/v1beta1.ts +++ b/src/apis/alertcenter/v1beta1.ts @@ -124,6 +124,64 @@ export namespace alertcenter_v1beta1 { */ loginDetails?: Schema$LoginDetails; } + /** + * Alerts from G Suite Security Center rules service configured by admin. + */ + export interface Schema$ActivityRule { + /** + * List of action names associated with the rule threshold. + */ + actionNames?: string[]; + /** + * Rule create timestamp. + */ + createTime?: string; + /** + * Description of the rule. + */ + description?: string; + /** + * Alert display name. + */ + displayName?: string; + /** + * Rule name. + */ + name?: string; + /** + * Query that is used to get the data from the associated source. + */ + query?: string; + /** + * List of alert ids superseded by this alert. It is used to indicate that + * this alert is essentially extension of superseded alerts and we found the + * relationship after creating these alerts. + */ + supersededAlerts?: string[]; + /** + * Alert id superseding this alert. It is used to indicate that superseding + * alert is essentially extension of this alert and we found the + * relationship after creating both alerts. + */ + supersedingAlert?: string; + /** + * Alert threshold is for example “COUNT > 5”. + */ + threshold?: string; + /** + * The trigger sources for this rule. * GMAIL_EVENTS * DEVICE_EVENTS * + * USER_EVENTS + */ + triggerSource?: string; + /** + * The timestamp of the last update to the rule. + */ + updateTime?: string; + /** + * Rule window size. Possible values are 1 hour or 24 hours. + */ + windowSize?: string; + } /** * An alert affecting a customer. */ @@ -179,6 +237,10 @@ export namespace alertcenter_v1beta1 { * types](/admin-sdk/alertcenter/reference/alert-types). */ type?: string; + /** + * Output only. The time this alert was last updated. + */ + updateTime?: string; } /** * A customer feedback about an alert. @@ -767,7 +829,7 @@ export namespace alertcenter_v1beta1 { * @param {object} params Parameters for request * @param {string=} params.customerId Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with. Inferred from the caller identity if not provided. * @param {string=} params.filter Optional. A query string for filtering alert results. For more details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.list). - * @param {string=} params.orderBy Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using `order_by="create_time desc"`. Currently, only sorting by `create_time desc` is supported. + * @param {string=} params.orderBy Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using `order_by="create_time desc"`. Currently, supported sorting are `create_time asc`, `create_time desc`, `update_time desc` * @param {integer=} params.pageSize Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default. * @param {string=} params.pageToken Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's next_page_token field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -953,8 +1015,8 @@ export namespace alertcenter_v1beta1 { * Optional. The sort order of the list results. If not specified results * may be returned in arbitrary order. You can sort the results in * descending order based on the creation timestamp using - * `order_by="create_time desc"`. Currently, only sorting by `create_time - * desc` is supported. + * `order_by="create_time desc"`. Currently, supported sorting are + * `create_time asc`, `create_time desc`, `update_time desc` */ orderBy?: string; /** diff --git a/src/apis/androiddeviceprovisioning/v1.ts b/src/apis/androiddeviceprovisioning/v1.ts index d8501d4dfd7..153c22499f5 100644 --- a/src/apis/androiddeviceprovisioning/v1.ts +++ b/src/apis/androiddeviceprovisioning/v1.ts @@ -414,6 +414,16 @@ export namespace androiddeviceprovisioning_v1 { * Output only. The type of claim made on the device. */ sectionType?: string; + /** + * The timestamp when the device will exit ‘vacation mode’. This value is + * present iff the device is in 'vacation mode'. + */ + vacationModeExpireTime?: string; + /** + * The timestamp when the device was put into ‘vacation mode’. This value is + * present iff the device is in 'vacation mode'. + */ + vacationModeStartTime?: string; } /** * Encapsulates hardware and product IDs to identify a manufactured device. To @@ -782,6 +792,15 @@ export namespace androiddeviceprovisioning_v1 { * Required. The section type of the device's provisioning record. */ sectionType?: string; + /** + * The duration of the vacation unlock starting from when the request is + * processed. (1 day is treated as 24 hours) + */ + vacationModeDays?: number; + /** + * The expiration time of the vacation unlock. + */ + vacationModeExpireTime?: string; } /** * Captures the processing status for each device in the operation. @@ -873,6 +892,15 @@ export namespace androiddeviceprovisioning_v1 { * Required. The section type of the device's provisioning record. */ sectionType?: string; + /** + * The duration of the vacation unlock starting from when the request is + * processed. (1 day is treated as 24 hours) + */ + vacationModeDays?: number; + /** + * The expiration time of the vacation unlock. + */ + vacationModeExpireTime?: string; } /** * Request to unclaim devices asynchronously in batch. diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index 124d896662f..19415df73a5 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -284,6 +284,10 @@ export namespace androidmanagement_v1 { * The package name of the app that installed this app. */ installerPackageName?: string; + /** + * List of keyed app states reported by the app. + */ + keyedAppStates?: Schema$KeyedAppState[]; /** * Package name of the app. */ @@ -315,6 +319,15 @@ export namespace androidmanagement_v1 { */ versionName?: string; } + /** + * Settings controlling the behavior of application reports. + */ + export interface Schema$ApplicationReportingSettings { + /** + * Whether removed apps are included in application reports. + */ + includeRemovedApps?: boolean; + } /** * A rule for automatically choosing a private key and certificate to * authenticate the device to a server. @@ -887,6 +900,41 @@ export namespace androidmanagement_v1 { */ skinTemperatures?: number[]; } + /** + * Keyed app state reported by the app. + */ + export interface Schema$KeyedAppState { + /** + * The creation time of the app state on the device. + */ + createTime?: string; + /** + * Optionally, a machine-readable value to be read by the EMM. For example, + * setting values that the admin can choose to query against in the EMM + * console (e.g. “notify me if the battery_warning data < 10”). + */ + data?: string; + /** + * The key for the app state. Acts as a point of reference for what the app + * is providing state for. For example, when providing managed configuration + * feedback, this key could be the managed configuration key. + */ + key?: string; + /** + * The time the app state was most recently updated. + */ + lastUpdateTime?: string; + /** + * Optionally, a free-form message string to explain the app state. If the + * state was triggered by a particular value (e.g. a managed configuration + * value), it should be included in the message. + */ + message?: string; + /** + * The severity of the app state. + */ + severity?: string; + } /** * An action to launch an app. */ @@ -1858,6 +1906,11 @@ export namespace androidmanagement_v1 { * Settings controlling the behavior of status reports. */ export interface Schema$StatusReportingSettings { + /** + * Application reporting settings. Only applicable if + * application_reports_enabled is true. + */ + applicationReportingSettings?: Schema$ApplicationReportingSettings; /** * Whether app reports are enabled. */ diff --git a/src/apis/androidpublisher/v2.ts b/src/apis/androidpublisher/v2.ts index 7101a1c1f5d..f7f850971e2 100644 --- a/src/apis/androidpublisher/v2.ts +++ b/src/apis/androidpublisher/v2.ts @@ -4442,7 +4442,7 @@ export namespace androidpublisher_v2 { * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. Acceptable values are: "alpha", "beta", "production", "rollout" or "internal". + * @param {string} params.track The track to read or modify. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4507,7 +4507,7 @@ export namespace androidpublisher_v2 { * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. Acceptable values are: "alpha", "beta", "production", "rollout" or "internal". + * @param {string} params.track The track to read or modify. * @param {().Testers} 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. @@ -4577,7 +4577,7 @@ export namespace androidpublisher_v2 { * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. Acceptable values are: "alpha", "beta", "production", "rollout" or "internal". + * @param {string} params.track The track to read or modify. * @param {().Testers} 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. @@ -4656,8 +4656,7 @@ export namespace androidpublisher_v2 { */ packageName?: string; /** - * The track to read or modify. Acceptable values are: "alpha", "beta", - * "production", "rollout" or "internal". + * The track to read or modify. */ track?: string; } @@ -4678,8 +4677,7 @@ export namespace androidpublisher_v2 { */ packageName?: string; /** - * The track to read or modify. Acceptable values are: "alpha", "beta", - * "production", "rollout" or "internal". + * The track to read or modify. */ track?: string; @@ -4705,8 +4703,7 @@ export namespace androidpublisher_v2 { */ packageName?: string; /** - * The track to read or modify. Acceptable values are: "alpha", "beta", - * "production", "rollout" or "internal". + * The track to read or modify. */ track?: string; @@ -4861,10 +4858,8 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.tracks.patch - * @desc Updates the track configuration for the specified track type. When - * halted, the rollout track cannot be updated without adding new APKs, and - * adding new APKs will cause it to resume. This method supports patch - * semantics. + * @desc Updates the track configuration for the specified track type. This + * method supports patch semantics. * @alias androidpublisher.edits.tracks.patch * @memberOf! () * @@ -4934,9 +4929,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.tracks.update - * @desc Updates the track configuration for the specified track type. When - * halted, the rollout track cannot be updated without adding new APKs, and - * adding new APKs will cause it to resume. + * @desc Updates the track configuration for the specified track type. * @alias androidpublisher.edits.tracks.update * @memberOf! () * diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index b039b106d49..eda3870d964 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -3865,7 +3865,7 @@ export namespace androidpublisher_v3 { * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. Acceptable values are: "alpha", "beta", "production", "rollout" or "internal". + * @param {string} params.track The track to read or modify. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3930,7 +3930,7 @@ export namespace androidpublisher_v3 { * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. Acceptable values are: "alpha", "beta", "production", "rollout" or "internal". + * @param {string} params.track The track to read or modify. * @param {().Testers} 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. @@ -4000,7 +4000,7 @@ export namespace androidpublisher_v3 { * @param {object} params Parameters for request * @param {string} params.editId Unique identifier for this edit. * @param {string} params.packageName Unique identifier for the Android app that is being updated; for example, "com.spiffygame". - * @param {string} params.track The track to read or modify. Acceptable values are: "alpha", "beta", "production", "rollout" or "internal". + * @param {string} params.track The track to read or modify. * @param {().Testers} 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. @@ -4079,8 +4079,7 @@ export namespace androidpublisher_v3 { */ packageName?: string; /** - * The track to read or modify. Acceptable values are: "alpha", "beta", - * "production", "rollout" or "internal". + * The track to read or modify. */ track?: string; } @@ -4101,8 +4100,7 @@ export namespace androidpublisher_v3 { */ packageName?: string; /** - * The track to read or modify. Acceptable values are: "alpha", "beta", - * "production", "rollout" or "internal". + * The track to read or modify. */ track?: string; @@ -4128,8 +4126,7 @@ export namespace androidpublisher_v3 { */ packageName?: string; /** - * The track to read or modify. Acceptable values are: "alpha", "beta", - * "production", "rollout" or "internal". + * The track to read or modify. */ track?: string; @@ -4284,10 +4281,8 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.tracks.patch - * @desc Updates the track configuration for the specified track type. When - * halted, the rollout track cannot be updated without adding new APKs, and - * adding new APKs will cause it to resume. This method supports patch - * semantics. + * @desc Updates the track configuration for the specified track type. This + * method supports patch semantics. * @alias androidpublisher.edits.tracks.patch * @memberOf! () * @@ -4357,9 +4352,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.tracks.update - * @desc Updates the track configuration for the specified track type. When - * halted, the rollout track cannot be updated without adding new APKs, and - * adding new APKs will cause it to resume. + * @desc Updates the track configuration for the specified track type. * @alias androidpublisher.edits.tracks.update * @memberOf! () * diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts index 64a72066d58..e4a00569bc2 100644 --- a/src/apis/appengine/v1.ts +++ b/src/apis/appengine/v1.ts @@ -2191,7 +2191,12 @@ export namespace appengine_v1 { * Engine application, for example a Cloud Storage bucket or App Engine * service account. Use this method if you receive an error message about a * missing feature, for example, Error retrieving the App Engine service - * account. + * account. If you have deleted your App Engine service account, this will + * not be able to recreate it. Instead, you should attempt to use the IAM + * undelete API if possible at + * https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D + * . If the deletion was recent, the numeric ID can be found in the Cloud + * Console Activity Log. * @alias appengine.apps.repair * @memberOf! () * diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index 7f4391a7159..30e9fb99726 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -2260,7 +2260,12 @@ export namespace appengine_v1beta { * Engine application, for example a Cloud Storage bucket or App Engine * service account. Use this method if you receive an error message about a * missing feature, for example, Error retrieving the App Engine service - * account. + * account. If you have deleted your App Engine service account, this will + * not be able to recreate it. Instead, you should attempt to use the IAM + * undelete API if possible at + * https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D + * . If the deletion was recent, the numeric ID can be found in the Cloud + * Console Activity Log. * @alias appengine.apps.repair * @memberOf! () * diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index d1ed55efb72..76d513ff83c 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -82,7 +82,6 @@ export namespace bigquery_v2 { context: APIRequestContext; datasets: Resource$Datasets; jobs: Resource$Jobs; - models: Resource$Models; projects: Resource$Projects; tabledata: Resource$Tabledata; tables: Resource$Tables; @@ -92,57 +91,12 @@ export namespace bigquery_v2 { this.datasets = new Resource$Datasets(this.context); this.jobs = new Resource$Jobs(this.context); - this.models = new Resource$Models(this.context); this.projects = new Resource$Projects(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. - */ - export interface Schema$AggregateClassificationMetrics { - /** - * Accuracy is the fraction of predictions given the correct label. For - * multiclass this is a micro-averaged metric. - */ - accuracy?: number; - /** - * The F1 score is an average of recall and precision. For multiclass this - * is a macro-averaged metric. - */ - f1Score?: number; - /** - * Logarithmic Loss. For multiclass this is a macro-averaged metric. - */ - logLoss?: number; - /** - * Precision is the fraction of actual positive predictions that had - * positive actual labels. For multiclass this is a macro-averaged metric - * treating each class as a binary classifier. - */ - precision?: number; - /** - * Recall is the fraction of actual positive labels that were given a - * positive prediction. For multiclass this is a macro-averaged metric. - */ - recall?: number; - /** - * Area Under a ROC Curve. For multiclass this is a macro-averaged metric. - */ - rocAuc?: number; - /** - * Threshold at which the metrics are computed. For binary classification - * models this is the positive class threshold. For multi-class - * classfication models this is the confidence threshold. - */ - threshold?: number; - } export interface Schema$BigQueryModelTraining { /** * [Output-only, Beta] Index of current ML training iteration. Updated @@ -266,52 +220,6 @@ export namespace bigquery_v2 { */ readRowkeyAsString?: boolean; } - /** - * Evaluation metrics for binary classification models. - */ - export interface Schema$BinaryClassificationMetrics { - /** - * Aggregate classification metrics. - */ - aggregateClassificationMetrics?: Schema$AggregateClassificationMetrics; - /** - * Binary confusion matrix at multiple thresholds. - */ - binaryConfusionMatrixList?: Schema$BinaryConfusionMatrix[]; - } - /** - * Confusion matrix for binary classification models. - */ - export interface Schema$BinaryConfusionMatrix { - /** - * Number of false samples predicted as false. - */ - falseNegatives?: string; - /** - * Number of false samples predicted as true. - */ - falsePositives?: string; - /** - * Threshold value used when computing each of the following metric. - */ - positiveClassThreshold?: number; - /** - * Aggregate precision. - */ - precision?: number; - /** - * Aggregate recall. - */ - recall?: number; - /** - * Number of true samples predicted as false. - */ - trueNegatives?: string; - /** - * Number of true samples predicted as true. - */ - truePositives?: string; - } export interface Schema$BqmlIterationResult { /** * [Output-only, Beta] Time taken to run the training iteration in @@ -369,35 +277,17 @@ export namespace bigquery_v2 { * training run. */ trainingOptions?: { + earlyStop?: boolean; l1Reg?: number; - maxIteration?: string; - learnRate?: number; - minRelProgress?: number; l2Reg?: number; - warmStart?: boolean; + learnRate?: number; learnRateStrategy?: string; lineSearchInitLearnRate?: number; - earlyStop?: boolean; + maxIteration?: string; + minRelProgress?: number; + warmStart?: boolean; }; } - /** - * Information about a single cluster for clustering model. - */ - export interface Schema$ClusterInfo { - /** - * Centroid id. - */ - centroidId?: string; - /** - * Cluster radius, the average distance from centroid to each point assigned - * to the cluster. - */ - clusterRadius?: number; - /** - * Cluster size, the total number of points assigned to the cluster. - */ - clusterSize?: string; - } export interface Schema$Clustering { /** * [Repeated] One or more fields on which data should be clustered. Only @@ -408,33 +298,6 @@ export namespace bigquery_v2 { */ fields?: string[]; } - /** - * Evaluation metrics for clustering models. - */ - export interface Schema$ClusteringMetrics { - /** - * Davies-Bouldin index. - */ - daviesBouldinIndex?: number; - /** - * Mean of squared distances between each sample to its cluster centroid. - */ - meanSquaredDistance?: number; - } - /** - * Confusion matrix for multi-class classification models. - */ - export interface Schema$ConfusionMatrix { - /** - * Confidence threshold used when computing the entries of the confusion - * matrix. - */ - confidenceThreshold?: number; - /** - * One row per actual label. - */ - rows?: Schema$Row[]; - } export interface Schema$CsvOptions { /** * [Optional] Indicates if BigQuery should accept rows that are missing @@ -493,13 +356,13 @@ export namespace bigquery_v2 { * access.userByEmail: [dataset creator email]; access.role: OWNER; */ access?: Array<{ - role?: string; - view?: Schema$TableReference; - groupByEmail?: string; - userByEmail?: string; domain?: string; + groupByEmail?: string; iamMember?: string; + role?: string; specialGroup?: string; + userByEmail?: string; + view?: Schema$TableReference; }>; /** * [Output-only] The time when this dataset was created, in milliseconds @@ -594,12 +457,12 @@ export namespace bigquery_v2 { * there are no datasets in the project. */ datasets?: Array<{ - id?: string; - location?: string; + datasetReference?: Schema$DatasetReference; friendlyName?: string; + id?: string; kind?: string; labels?: {[key: string]: string;}; - datasetReference?: Schema$DatasetReference; + location?: string; }>; /** * A hash value of the results page. You can use this property to determine @@ -660,20 +523,6 @@ export namespace bigquery_v2 { */ kmsKeyName?: string; } - /** - * A single entry in the confusion matrix. - */ - export interface Schema$Entry { - /** - * Number of items being predicted as this label. - */ - itemCount?: string; - /** - * The predicted label. For confidence_threshold > 0, we will also add an - * entry indicating the number of items under the confidence threshold. - */ - predictedLabel?: string; - } export interface Schema$ErrorProto { /** * Debugging information. This property is internal to Google and should not @@ -693,29 +542,6 @@ 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. - */ - export interface Schema$EvaluationMetrics { - /** - * Populated for binary classification models. - */ - binaryClassificationMetrics?: Schema$BinaryClassificationMetrics; - /** - * [Beta] Populated for clustering models. - */ - clusteringMetrics?: Schema$ClusteringMetrics; - /** - * Populated for multi-class classification models. - */ - multiClassClassificationMetrics?: Schema$MultiClassClassificationMetrics; - /** - * Populated for regression models. - */ - regressionMetrics?: Schema$RegressionMetrics; - } export interface Schema$ExplainQueryStage { /** * Number of parallel input segments completed. @@ -1027,35 +853,6 @@ export namespace bigquery_v2 { */ skipLeadingRows?: string; } - /** - * Information about a single iteration of the training run. - */ - export interface Schema$IterationResult { - /** - * [Beta] Information about top clusters for clustering models. - */ - clusterInfos?: Schema$ClusterInfo[]; - /** - * Time taken to run the iteration in milliseconds. - */ - durationMs?: string; - /** - * Loss computed on the eval data at the end of iteration. - */ - evalLoss?: number; - /** - * Index of the iteration, 0 based. - */ - index?: number; - /** - * Learn rate used for this iteration. - */ - learnRate?: number; - /** - * Loss computed on the training data at the end of iteration. - */ - trainingLoss?: number; - } export interface Schema$Job { /** * [Required] Describes the job configuration. @@ -1592,14 +1389,14 @@ export namespace bigquery_v2 { */ jobs?: Array<{ configuration?: Schema$JobConfiguration; - user_email?: string; errorResult?: Schema$ErrorProto; - kind?: string; + id?: string; jobReference?: Schema$JobReference; - status?: Schema$JobStatus; + kind?: string; state?: string; statistics?: Schema$JobStatistics; - id?: string; + status?: Schema$JobStatus; + user_email?: string; }>; /** * The resource type of the response. @@ -1750,7 +1547,7 @@ 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] The schema of the results. Present only for successful dry * run of non-legacy SQL queries. @@ -1875,18 +1672,6 @@ export namespace bigquery_v2 { */ export interface Schema$JsonObject {} export interface Schema$JsonValue {} - export interface Schema$ListModelsResponse { - /** - * Models in the requested dataset. Only the following fields are populated: - * model_reference, model_type, creation_time, last_modified_time and - * labels. - */ - models?: Schema$Model[]; - /** - * A token to request the next page of results. - */ - nextPageToken?: string; - } export interface Schema$MaterializedViewDefinition { /** * [Output-only] [TrustedTester] The time when this materialized view was @@ -1898,78 +1683,6 @@ export namespace bigquery_v2 { */ query?: string; } - export interface Schema$Model { - /** - * Output only. The time when this model was created, in millisecs since the - * epoch. - */ - creationTime?: string; - /** - * [Optional] A user-friendly description of this model. @mutable - * bigquery.models.patch - */ - description?: string; - /** - * Output only. A hash of this resource. - */ - 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 - */ - expirationTime?: string; - /** - * Output only. Input feature columns that were used to train this model. - */ - featureColumns?: Schema$StandardSqlField[]; - /** - * [Optional] A descriptive name for this model. @mutable - * bigquery.models.patch - */ - 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. - */ - 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 - */ - labels?: {[key: string]: string;}; - /** - * Output only. The time when this model was last modified, in millisecs - * since the epoch. - */ - lastModifiedTime?: string; - /** - * Output only. The geographic location where the model resides. This value - * is inherited from the dataset. - */ - location?: string; - /** - * Required. Unique identifier for this model. - */ - modelReference?: Schema$ModelReference; - /** - * Output only. Type of the model resource. - */ - modelType?: string; - /** - * Output only. Information for all training runs in increasing order of - * start_time. - */ - trainingRuns?: Schema$TrainingRun[]; - } export interface Schema$ModelDefinition { /** * [Output-only, Beta] Model options used for the first training run. These @@ -1985,38 +1698,6 @@ export namespace bigquery_v2 { */ trainingRuns?: Schema$BqmlTrainingRun[]; } - /** - * Id path of a model. - */ - export interface Schema$ModelReference { - /** - * [Required] The ID of the dataset containing this model. - */ - datasetId?: string; - /** - * [Required] The ID of the model. The ID must contain only letters (a-z, - * A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 - * characters. - */ - modelId?: string; - /** - * [Required] The ID of the project containing this model. - */ - projectId?: string; - } - /** - * Evaluation metrics for multi-class classification models. - */ - export interface Schema$MultiClassClassificationMetrics { - /** - * Aggregate classification metrics. - */ - aggregateClassificationMetrics?: Schema$AggregateClassificationMetrics; - /** - * Confusion matrix at different thresholds. - */ - confusionMatrixList?: Schema$ConfusionMatrix[]; - } export interface Schema$ProjectList { /** * A hash of the page of results @@ -2034,11 +1715,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; + id?: string; kind?: string; + numericId?: string; + projectReference?: Schema$ProjectReference; }>; /** * The total number of projects in the list. @@ -2077,8 +1758,8 @@ export namespace bigquery_v2 { * struct. */ structTypes?: Array<{ - name?: string; description?: string; + name?: string; type?: Schema$QueryParameterType; }>; /** @@ -2275,32 +1956,7 @@ export namespace bigquery_v2 { /** * [TrustedTester] [Required] Defines the ranges for range partitioning. */ - range?: {start?: string; end?: string; interval?: string;}; - } - /** - * Evaluation metrics for regression models. - */ - export interface Schema$RegressionMetrics { - /** - * Mean absolute error. - */ - meanAbsoluteError?: number; - /** - * Mean squared error. - */ - meanSquaredError?: number; - /** - * Mean squared log error. - */ - meanSquaredLogError?: number; - /** - * Median absolute error. - */ - medianAbsoluteError?: number; - /** - * R^2 score. - */ - rSquared?: number; + range?: {end?: string; interval?: string; start?: string;}; } export interface Schema$RoutineReference { /** @@ -2318,62 +1974,6 @@ export namespace bigquery_v2 { */ routineId?: string; } - /** - * A single row in the confusion matrix. - */ - export interface Schema$Row { - /** - * The original label of this row. - */ - actualLabel?: string; - /** - * Info describing predicted label distribution. - */ - entries?: Schema$Entry[]; - } - /** - * The type of a variable, e.g., a function argument. Examples: INT64: - * {type_kind="INT64"} ARRAY<STRING>: - * {type_kind="ARRAY", array_element_type="STRING"} - * STRUCT<x STRING, y ARRAY<DATE>>: {type_kind="STRUCT", - * struct_type={fields=[ {name="x", - * type={type_kind="STRING"}}, {name="y", - * type={type_kind="ARRAY", array_element_type="DATE"}} - * ]}} - */ - export interface Schema$StandardSqlDataType { - /** - * The type of the array's elements, if type_kind = "ARRAY". - */ - arrayElementType?: Schema$StandardSqlDataType; - /** - * The fields of this struct, in order, if type_kind = "STRUCT". - */ - structType?: Schema$StandardSqlStructType; - /** - * Required. The top level type of this field. Can be any standard SQL data - * type (e.g., "INT64", "DATE", "ARRAY"). - */ - typeKind?: string; - } - /** - * A field or a column. - */ - export interface Schema$StandardSqlField { - /** - * Optional. The name of this field. Can be absent for struct fields. - */ - name?: string; - /** - * Optional. The type of this parameter. Absent if not explicitly specified - * (e.g., CREATE FUNCTION statement can omit the return type; in this case - * the output parameter does not have this "type" field). - */ - type?: Schema$StandardSqlDataType; - } - export interface Schema$StandardSqlStructType { - fields?: Schema$StandardSqlField[]; - } export interface Schema$Streamingbuffer { /** * [Output-only] A lower-bound estimate of the number of bytes currently in @@ -2663,16 +2263,16 @@ export namespace bigquery_v2 { * Tables in the requested dataset. */ tables?: Array<{ - creationTime?: string; - labels?: {[key: string]: string;}; clustering?: Schema$Clustering; - type?: string; + creationTime?: string; expirationTime?: string; + friendlyName?: string; id?: string; + kind?: string; + labels?: {[key: string]: string;}; tableReference?: Schema$TableReference; timePartitioning?: Schema$TimePartitioning; - friendlyName?: string; - kind?: string; + type?: string; view?: {useLegacySql?: boolean;}; }>; /** @@ -2731,111 +2331,6 @@ export namespace bigquery_v2 { */ type?: string; } - export interface Schema$TrainingOptions { - /** - * The column to split data with. This column won't be used as a - * feature. 1. When data_split_method is CUSTOM, the corresponding column - * should be boolean. The rows with true value tag are eval data, and the - * false are training data. 2. When data_split_method is SEQ, the first - * DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the - * corresponding column are used as training data, and the rest are eval - * data. It respects the order in Orderable data types: - * https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties - */ - dataSplitColumn?: string; - /** - * The fraction of evaluation data over the whole input data. The rest of - * data will be used as training data. The format should be double. Accurate - * to two decimal places. Default value is 0.2. - */ - dataSplitEvalFraction?: number; - /** - * The data split type for training and evaluation, e.g. RANDOM. - */ - dataSplitMethod?: string; - /** - * [Beta] Distance type for clustering models. - */ - distanceType?: string; - /** - * Whether to stop early when the loss doesn't improve significantly any - * more (compared to min_relative_progress). - */ - earlyStop?: boolean; - /** - * Specifies the initial learning rate for line search to start at. - */ - initialLearnRate?: number; - /** - * Name of input label columns in training data. - */ - inputLabelColumns?: string[]; - /** - * L1 regularization coefficient. - */ - l1Regularization?: number; - /** - * L2 regularization coefficient. - */ - l2Regularization?: number; - /** - * Weights associated with each label class, for rebalancing the training - * data. - */ - labelClassWeights?: {[key: string]: number;}; - /** - * Learning rate in training. - */ - learnRate?: number; - /** - * The strategy to determine learning rate. - */ - learnRateStrategy?: string; - /** - * Type of loss function used during training run. - */ - lossType?: string; - /** - * The maximum number of iterations in training. - */ - maxIterations?: string; - /** - * When early_stop is true, stops training when accuracy improvement is less - * than 'min_relative_progress'. - */ - minRelativeProgress?: number; - /** - * [Beta] Number of clusters for clustering models. - */ - numClusters?: string; - /** - * Whether to train a model from the last checkpoint. - */ - warmStart?: boolean; - } - /** - * Information about a single training query run for the model. - */ - export interface Schema$TrainingRun { - /** - * The evaluation metrics over training/eval data that were computed at the - * end of training. - */ - evaluationMetrics?: Schema$EvaluationMetrics; - /** - * Output of each iteration run, results.size() <= max_iterations. - */ - results?: Schema$IterationResult[]; - /** - * The start time of this training run. - */ - startTime?: string; - /** - * Options that were used for this training run, includes user specified and - * default options that were used. - */ - trainingOptions?: Schema$TrainingOptions; - } export interface Schema$UserDefinedFunctionResource { /** * [Pick one] An inline resource that contains code for a user-defined @@ -4735,373 +4230,6 @@ export namespace bigquery_v2 { } - export class Resource$Models { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - - /** - * bigquery.models.delete - * @desc Deletes the model specified by modelId from the dataset. - * @alias bigquery.models.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.datasetId Dataset ID of the model to delete. - * @param {string} params.modelId Model ID of the model to delete. - * @param {string} params.projectId Project ID of the model 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$Models$Delete, options?: MethodOptions): - GaxiosPromise; - delete( - params: Params$Resource$Models$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Models$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Models$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void|GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Models$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Models$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/models/{+modelId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['projectId', 'datasetId', 'modelId'], - pathParams: ['datasetId', 'modelId', 'projectId'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * bigquery.models.get - * @desc Gets the specified model resource by model ID. - * @alias bigquery.models.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.datasetId Dataset ID of the requested model. - * @param {string} params.modelId Model ID of the requested model. - * @param {string} params.projectId Project ID of the requested model. - * @param {object} [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$Models$Get, - options?: MethodOptions): GaxiosPromise; - get(params: Params$Resource$Models$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Models$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Models$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Models$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Models$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/models/{+modelId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['projectId', 'datasetId', 'modelId'], - pathParams: ['datasetId', 'modelId', 'projectId'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * bigquery.models.list - * @desc Lists all models in the specified dataset. Requires the READER - * dataset role. - * @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 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; - list( - params: Params$Resource$Models$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Models$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Models$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Models$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/models') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['projectId', 'datasetId'], - pathParams: ['datasetId', 'projectId'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * bigquery.models.patch - * @desc Patch specific fields in the specified model. - * @alias bigquery.models.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.datasetId Dataset ID of the model to patch. - * @param {string} params.modelId Model ID of the model to patch. - * @param {string} params.projectId Project ID of the model to patch. - * @param {().Model} 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$Models$Patch, options?: MethodOptions): - GaxiosPromise; - patch( - params: Params$Resource$Models$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Models$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Models$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Models$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Models$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/bigquery/v2/projects/{+projectId}/datasets/{+datasetId}/models/{+modelId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['projectId', 'datasetId', 'modelId'], - pathParams: ['datasetId', 'modelId', 'projectId'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Models$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Dataset ID of the model to delete. - */ - datasetId?: string; - /** - * Model ID of the model to delete. - */ - modelId?: string; - /** - * Project ID of the model to delete. - */ - projectId?: string; - } - export interface Params$Resource$Models$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Dataset ID of the requested model. - */ - datasetId?: string; - /** - * Model ID of the requested model. - */ - modelId?: string; - /** - * Project ID of the requested model. - */ - projectId?: string; - } - export interface Params$Resource$Models$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Dataset ID of the models to list. - */ - datasetId?: string; - /** - * The maximum number of results per page. - */ - maxResults?: number; - /** - * Page token, returned by a previous call to request the next page of - * results - */ - pageToken?: string; - /** - * Project ID of the models to list. - */ - projectId?: string; - } - export interface Params$Resource$Models$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Dataset ID of the model to patch. - */ - datasetId?: string; - /** - * Model ID of the model to patch. - */ - modelId?: string; - /** - * Project ID of the model to patch. - */ - projectId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Model; - } - - export class Resource$Projects { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index 418064d24d0..77190fe8c31 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -201,10 +201,9 @@ export namespace bigtableadmin_v2 { */ export interface Schema$Binding { /** - * Unimplemented. The condition that is associated with this binding. NOTE: - * an unsatisfied condition will not allow user access via current binding. - * Different bindings, including their conditions, are examined - * independently. + * The condition that is associated with this binding. NOTE: An unsatisfied + * condition will not allow user access via current binding. Different + * bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** @@ -3617,7 +3616,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 tables should be listed. Values are of the form `projects//instances/`. * @param {string=} params.view The view to be applied to the returned tables' fields. Defaults to `NAME_ONLY` if unspecified; no others are currently supported. @@ -4034,7 +4033,12 @@ 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; /** diff --git a/src/apis/binaryauthorization/v1beta1.ts b/src/apis/binaryauthorization/v1beta1.ts index fcafe00c67b..fcd34289439 100644 --- a/src/apis/binaryauthorization/v1beta1.ts +++ b/src/apis/binaryauthorization/v1beta1.ts @@ -210,7 +210,7 @@ export namespace binaryauthorization_v1beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/cloudbilling/v1.ts b/src/apis/cloudbilling/v1.ts index 2d5eb63274f..aac29e71a19 100644 --- a/src/apis/cloudbilling/v1.ts +++ b/src/apis/cloudbilling/v1.ts @@ -216,10 +216,9 @@ export namespace cloudbilling_v1 { */ export interface Schema$Binding { /** - * Unimplemented. The condition that is associated with this binding. NOTE: - * an unsatisfied condition will not allow user access via current binding. - * Different bindings, including their conditions, are examined - * independently. + * The condition that is associated with this binding. NOTE: An unsatisfied + * condition will not allow user access via current binding. Different + * bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** diff --git a/src/apis/cloudbuild/v1alpha1.ts b/src/apis/cloudbuild/v1alpha1.ts index fc85794d5b3..ecf99685982 100644 --- a/src/apis/cloudbuild/v1alpha1.ts +++ b/src/apis/cloudbuild/v1alpha1.ts @@ -788,7 +788,7 @@ export namespace cloudbuild_v1alpha1 { */ name?: string; /** - * The project ID of the GCP project in which the `WorkerPool` is created. + * The project ID of the GCP project for which the `WorkerPool` is created. */ projectId?: string; /** diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index 3b18e844193..6fc53229715 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -168,7 +168,7 @@ export namespace cloudfunctions_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ @@ -264,8 +264,7 @@ export namespace cloudfunctions_v1 { labels?: {[key: string]: string;}; /** * The limit on the maximum number of function instances that may coexist at - * a given time. This feature is currently in alpha, available only for - * whitelisted users. + * a given time. */ maxInstances?: number; /** @@ -289,10 +288,9 @@ export namespace cloudfunctions_v1 { */ network?: string; /** - * The runtime in which the function is going to run. Example values - * include: `go111`: for Go 1.11 `nodejs6`: for Node.js 6 `nodejs8`: for - * Node.js 8 `nodejs10`: for Node.js 10 `python37`: for Python 3.7 `ruby25`: - * for Ruby 2.5 If empty, defaults to `nodejs6`. + * Required. The runtime in which the function is going to run. Choices: * + * `nodejs6`: Node.js 6 * `nodejs8`: Node.js 8 * `nodejs10`: Node.js 10 * + * `python37`: Python 3.7 * `go111`: Go 1.11 */ runtime?: string; /** diff --git a/src/apis/cloudfunctions/v1beta2.ts b/src/apis/cloudfunctions/v1beta2.ts index 5541f320ca2..abd9bb09464 100644 --- a/src/apis/cloudfunctions/v1beta2.ts +++ b/src/apis/cloudfunctions/v1beta2.ts @@ -178,8 +178,7 @@ export namespace cloudfunctions_v1beta2 { latestOperation?: string; /** * The limit on the maximum number of function instances that may coexist at - * a given time. This feature is currently in alpha, available only for - * whitelisted users. + * a given time. */ maxInstances?: number; /** @@ -203,8 +202,9 @@ export namespace cloudfunctions_v1beta2 { */ network?: string; /** - * The runtime in which the function is going to run. If empty, defaults to - * Node.js 6. + * Required. The runtime in which the function is going to run. Choices: * + * `nodejs6`: Node.js 6 * `nodejs8`: Node.js 8 * `nodejs10`: Node.js 10 * + * `python37`: Python 3.7 * `go111`: Go 1.11 */ runtime?: string; /** diff --git a/src/apis/cloudiot/v1.ts b/src/apis/cloudiot/v1.ts index f190a6174d2..983d8e7421c 100644 --- a/src/apis/cloudiot/v1.ts +++ b/src/apis/cloudiot/v1.ts @@ -132,7 +132,7 @@ export namespace cloudiot_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/cloudprivatecatalogproducer/v1beta1.ts b/src/apis/cloudprivatecatalogproducer/v1beta1.ts index b77cb701eb1..90dc9425e5f 100644 --- a/src/apis/cloudprivatecatalogproducer/v1beta1.ts +++ b/src/apis/cloudprivatecatalogproducer/v1beta1.ts @@ -436,7 +436,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ export interface Schema$GoogleIamV1Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/cloudresourcemanager/v1.ts b/src/apis/cloudresourcemanager/v1.ts index 4a02637bae4..731ba601189 100644 --- a/src/apis/cloudresourcemanager/v1.ts +++ b/src/apis/cloudresourcemanager/v1.ts @@ -184,7 +184,7 @@ export namespace cloudresourcemanager_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/cloudresourcemanager/v1beta1.ts b/src/apis/cloudresourcemanager/v1beta1.ts index 5a293de0444..b82ec01e569 100644 --- a/src/apis/cloudresourcemanager/v1beta1.ts +++ b/src/apis/cloudresourcemanager/v1beta1.ts @@ -178,7 +178,7 @@ export namespace cloudresourcemanager_v1beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/cloudresourcemanager/v2.ts b/src/apis/cloudresourcemanager/v2.ts index fc1c84e6e3a..52c1ddce8c0 100644 --- a/src/apis/cloudresourcemanager/v2.ts +++ b/src/apis/cloudresourcemanager/v2.ts @@ -169,7 +169,7 @@ export namespace cloudresourcemanager_v2 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/cloudresourcemanager/v2beta1.ts b/src/apis/cloudresourcemanager/v2beta1.ts index c2648fed2de..24f941682a5 100644 --- a/src/apis/cloudresourcemanager/v2beta1.ts +++ b/src/apis/cloudresourcemanager/v2beta1.ts @@ -169,7 +169,7 @@ export namespace cloudresourcemanager_v2beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/cloudscheduler/index.ts b/src/apis/cloudscheduler/index.ts index f82720dd34b..90db3150447 100644 --- a/src/apis/cloudscheduler/index.ts +++ b/src/apis/cloudscheduler/index.ts @@ -14,19 +14,27 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {cloudscheduler_v1} from './v1'; import {cloudscheduler_v1beta1} from './v1beta1'; export const VERSIONS = { + 'v1': cloudscheduler_v1.Cloudscheduler, 'v1beta1': cloudscheduler_v1beta1.Cloudscheduler, }; +export function cloudscheduler(version: 'v1'): cloudscheduler_v1.Cloudscheduler; +export function cloudscheduler(options: cloudscheduler_v1.Options): + cloudscheduler_v1.Cloudscheduler; export function cloudscheduler(version: 'v1beta1'): cloudscheduler_v1beta1.Cloudscheduler; export function cloudscheduler(options: cloudscheduler_v1beta1.Options): cloudscheduler_v1beta1.Cloudscheduler; -export function cloudscheduler( +export function cloudscheduler< + T = cloudscheduler_v1.Cloudscheduler | + cloudscheduler_v1beta1.Cloudscheduler>( this: GoogleConfigurable, - versionOrOptions: 'v1beta1'|cloudscheduler_v1beta1.Options) { + versionOrOptions: 'v1'| + cloudscheduler_v1.Options|'v1beta1'|cloudscheduler_v1beta1.Options) { return getAPI('cloudscheduler', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/cloudscheduler/v1.ts b/src/apis/cloudscheduler/v1.ts new file mode 100644 index 00000000000..f0d4234a639 --- /dev/null +++ b/src/apis/cloudscheduler/v1.ts @@ -0,0 +1,1508 @@ +/** + * 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 {GaxiosPromise} from 'gaxios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; +import {APIRequestContext, BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace cloudscheduler_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; + } + + /** + * Cloud Scheduler API + * + * Creates and manages jobs run on a regular recurring schedule. + * + * @example + * const {google} = require('googleapis'); + * const cloudscheduler = google.cloudscheduler('v1'); + * + * @namespace cloudscheduler + * @type {Function} + * @version v1 + * @variation v1 + * @param {object=} options Options for Cloudscheduler + */ + export class Cloudscheduler { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = {_options: options || {}, google}; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * App Engine target. The job will be pushed to a job handler by means of an + * HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job + * is acknowledged by means of an HTTP response code in the range [200 - 299]. + * Error 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, + * constitutes a failed attempt. + */ + export interface Schema$AppEngineHttpTarget { + /** + * App Engine Routing setting for the job. + */ + appEngineRouting?: Schema$AppEngineRouting; + /** + * Body. HTTP request body. A request body is allowed only if the HTTP + * method is POST or PUT. It will result in invalid argument error to set a + * body on a job with an incompatible HttpMethod. + */ + body?: string; + /** + * HTTP request headers. This map contains the header field names and + * values. Headers can be set when the job is created. Cloud Scheduler sets + * some headers to default values: * `User-Agent`: By default, this header + * is `"AppEngine-Google; (+http://code.google.com/appengine)"`. + * This header can be modified, but Cloud Scheduler will append + * `"AppEngine-Google; (+http://code.google.com/appengine)"` to + * the modified `User-Agent`. * `X-CloudScheduler`: This header will be + * set to true. If the job has an body, Cloud Scheduler sets the following + * headers: * `Content-Type`: By default, the `Content-Type` header is set + * to `"application/octet-stream"`. The default can be + * overridden by explictly setting `Content-Type` to a particular media + * type when the job is created. For example, `Content-Type` can be set + * to `"application/json"`. * `Content-Length`: This is computed + * by Cloud Scheduler. This value is output only. It cannot be changed. + * The headers below are output only. They cannot be set or overridden: * + * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google + * internal use only. In addition, some App Engine headers, which contain + * job-specific information, are also be sent to the job handler. + */ + headers?: {[key: string]: string;}; + /** + * The HTTP method to use for the request. PATCH and OPTIONS are not + * permitted. + */ + httpMethod?: string; + /** + * The relative URI. The relative URL must begin with "/" and + * must be a valid HTTP relative URL. It can contain a path, query string + * arguments, and `#` fragments. If the relative URL is empty, then the root + * path "/" will be used. No spaces are allowed, and the maximum + * length allowed is 2083 characters. + */ + relativeUri?: string; + } + /** + * App Engine Routing. For more information about services, versions, and + * instances see [An Overview of App + * Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), + * [Microservices Architecture on Google App + * Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), + * [App Engine Standard request + * routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), + * and [App Engine Flex request + * routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). + */ + export interface Schema$AppEngineRouting { + /** + * Output only. The host that the job is sent to. For more information + * about how App Engine requests are routed, see + * [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). + * The host is constructed as: * `host = + * [application_domain_name]`</br> `| [service] + '.' + + * [application_domain_name]`</br> `| [version] + '.' + + * [application_domain_name]`</br> `| [version_dot_service]+ + * '.' + [application_domain_name]`</br> `| [instance] + + * '.' + [application_domain_name]`</br> `| + * [instance_dot_service] + '.' + + * [application_domain_name]`</br> `| [instance_dot_version] + + * '.' + [application_domain_name]`</br> `| + * [instance_dot_version_dot_service] + '.' + + * [application_domain_name]` * `application_domain_name` = The domain name + * of the app, for example <app-id>.appspot.com, which is associated + * with the job's project ID. * `service =` service * `version =` + * version * `version_dot_service =` version `+ '.' +` service + * * `instance =` instance * `instance_dot_service =` instance `+ + * '.' +` service * `instance_dot_version =` instance `+ + * '.' +` version * `instance_dot_version_dot_service =` instance + * `+ '.' +` version `+ '.' +` service If service is + * empty, then the job will be sent to the service which is the default + * service when the job is attempted. If version is empty, then the job + * will be sent to the version which is the default version when the job is + * attempted. If instance is empty, then the job will be sent to an + * instance which is available when the job is attempted. If service, + * version, or instance is invalid, then the job will be sent to the default + * version of the default service when the job is attempted. + */ + host?: string; + /** + * App instance. By default, the job is sent to an instance which is + * available when the job is attempted. Requests can only be sent to a + * specific instance if [manual scaling is used in App Engine + * Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). + * App Engine Flex does not support instances. For more information, see + * [App Engine Standard request + * routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) + * and [App Engine Flex request + * routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). + */ + instance?: string; + /** + * App service. By default, the job is sent to the service which is the + * default service when the job is attempted. + */ + service?: string; + /** + * App version. By default, the job is sent to the version which is the + * default version when the job is attempted. + */ + version?: 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 {} + /** + * Http target. The job will be pushed to the job handler by means of an HTTP + * request via an http_method such as HTTP POST, HTTP GET, etc. The job is + * acknowledged by means of an HTTP response code in the range [200 - 299]. A + * failure to receive a response constitutes a failed execution. For a + * redirected request, the response returned by the redirected request is + * considered. + */ + export interface Schema$HttpTarget { + /** + * 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 job with an + * incompatible HttpMethod. + */ + body?: string; + /** + * The user can specify HTTP request headers to send with the job's HTTP + * request. This map contains the header field names and values. Repeated + * headers are not supported, but a header value can contain commas. These + * headers represent a subset of the headers that will accompany the + * job's HTTP request. Some HTTP request headers will be ignored or + * replaced. A partial list of headers that will be ignored or replaced is + * below: - Host: This will be computed by Cloud Scheduler and derived from + * uri. * `Content-Length`: This will be computed by Cloud Scheduler. * + * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * + * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google + * internal use only. The total size of headers must be less than 80KB. + */ + headers?: {[key: string]: string;}; + /** + * Which HTTP method to use for the request. + */ + httpMethod?: string; + /** + * Required. The full URI path that the request will be sent to. This + * string must begin with either "http://" or + * "https://". Some examples of valid values for uri are: + * `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will + * encode some characters for safety and compatibility. The maximum allowed + * URL length is 2083 characters after encoding. + */ + uri?: string; + } + /** + * Configuration for a job. The maximum allowed size for a job is 100KB. + */ + export interface Schema$Job { + /** + * App Engine HTTP target. + */ + appEngineHttpTarget?: Schema$AppEngineHttpTarget; + /** + * Optionally caller-specified in CreateJob or UpdateJob. A human-readable + * description for the job. This string must not contain more than 500 + * characters. + */ + description?: string; + /** + * HTTP target. + */ + httpTarget?: Schema$HttpTarget; + /** + * Output only. The time the last job attempt started. + */ + lastAttemptTime?: string; + /** + * 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?: string; + /** + * Pub/Sub target. + */ + pubsubTarget?: Schema$PubsubTarget; + /** + * Settings that determine the retry behavior. + */ + retryConfig?: Schema$RetryConfig; + /** + * Required, except when used with UpdateJob. Describes the schedule on + * which the job will be executed. The schedule can be either of the + * following types: * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) + * * English-like + * [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) + * As a general rule, execution `n + 1` of a job will not begin until + * execution `n` has finished. Cloud Scheduler will never allow two + * simultaneously outstanding executions. For example, this implies that if + * the `n+1`th execution is scheduled to run at 16:00 but the `n`th + * execution takes until 16:15, the `n+1`th execution will not start until + * `16:15`. A scheduled start time will be delayed if the previous execution + * has not ended when its scheduled time occurs. If retry_count > 0 and + * a job attempt fails, the job will be tried a total of retry_count times, + * with exponential backoff, until the next scheduled start time. + */ + schedule?: string; + /** + * Output only. The next time the job is scheduled. Note that this may be a + * retry of a previously failed attempt or the next execution time according + * to the schedule. + */ + scheduleTime?: string; + /** + * Output only. State of the job. + */ + state?: string; + /** + * Output only. The response from the target for the last attempted + * execution. + */ + status?: Schema$Status; + /** + * Specifies the time zone to be used in interpreting schedule. The value of + * this field must be a time zone name from the [tz + * database](http://en.wikipedia.org/wiki/Tz_database). Note that some time + * zones include a provision for daylight savings time. The rules for + * daylight saving time are determined by the chosen tz. For UTC use the + * string "utc". If a time zone is not specified, the default will + * be in UTC (also known as GMT). + */ + timeZone?: string; + /** + * Output only. The creation time of the job. + */ + userUpdateTime?: string; + } + /** + * Response message for listing jobs using ListJobs. + */ + export interface Schema$ListJobsResponse { + /** + * The list of jobs. + */ + jobs?: Schema$Job[]; + /** + * A token to retrieve next page of results. Pass this value in the + * page_token field in the subsequent call to ListJobs to retrieve the next + * page of results. If this is empty it indicates that there are no more + * results through which to paginate. The page token is valid for only 2 + * hours. + */ + 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; + } + /** + * 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 PauseJob. + */ + export interface Schema$PauseJobRequest {} + /** + * A message that is published by publishers and consumed by subscribers. The + * message must contain either a non-empty data field or at least one + * attribute. Note that client libraries represent this object differently + * depending on the language. See the corresponding <a + * href="https://cloud.google.com/pubsub/docs/reference/libraries">client + * library documentation</a> for more information. See <a + * href="https://cloud.google.com/pubsub/quotas">Quotas and + * limits</a> for more information about message limits. + */ + export interface Schema$PubsubMessage { + /** + * Optional attributes for this message. + */ + attributes?: {[key: string]: string;}; + /** + * The message data field. If this field is empty, the message must contain + * at least one attribute. + */ + data?: string; + /** + * ID of this message, assigned by the server when the message is published. + * Guaranteed to be unique within the topic. This value may be read by a + * subscriber that receives a `PubsubMessage` via a `Pull` call or a push + * delivery. It must not be populated by the publisher in a `Publish` call. + */ + messageId?: string; + /** + * The time at which the message was published, populated by the server when + * it receives the `Publish` call. It must not be populated by the publisher + * in a `Publish` call. + */ + publishTime?: string; + } + /** + * Pub/Sub target. The job will be delivered by publishing a message to the + * given Pub/Sub topic. + */ + export interface Schema$PubsubTarget { + /** + * Attributes for PubsubMessage. Pubsub message must contain either + * non-empty data, or at least one attribute. + */ + attributes?: {[key: string]: string;}; + /** + * The message payload for PubsubMessage. Pubsub message must contain + * either non-empty data, or at least one attribute. + */ + data?: string; + /** + * Required. The name of the Cloud Pub/Sub topic to which messages will be + * published when a job is delivered. The topic name must be in the same + * format as required by PubSub's + * [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), + * for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in + * the same project as the Cloud Scheduler job. + */ + topicName?: string; + } + /** + * Request message for ResumeJob. + */ + export interface Schema$ResumeJobRequest {} + /** + * Settings that determine the retry behavior. By default, if a job does not + * complete successfully (meaning that an acknowledgement is not received from + * the handler, then it will be retried with exponential backoff according to + * the settings in RetryConfig. + */ + export interface Schema$RetryConfig { + /** + * The maximum amount of time to wait before retrying a job after it fails. + * The default value of this field is 1 hour. + */ + maxBackoffDuration?: string; + /** + * The time between retries will double `max_doublings` times. A job's + * retry interval starts at min_backoff_duration, then doubles + * `max_doublings` times, then increases linearly, and finally retries + * retries at intervals of max_backoff_duration up to retry_count times. For + * example, if min_backoff_duration is 10s, max_backoff_duration is 300s, + * and `max_doublings` is 3, then the a job will first be retried in 10s. + * The retry interval will double three times, and then increase linearly by + * 2^3 * 10s. Finally, the job will retry at intervals of + * max_backoff_duration until the job has been attempted retry_count times. + * Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, + * 300s, .... The default value of this field is 5. + */ + maxDoublings?: number; + /** + * The time limit for retrying a failed job, measured from time when an + * execution was first attempted. If specified with retry_count, the job + * will be retried until both limits are reached. The default value for + * max_retry_duration is zero, which means retry duration is unlimited. + */ + maxRetryDuration?: string; + /** + * The minimum amount of time to wait before retrying a job after it fails. + * The default value of this field is 5 seconds. + */ + minBackoffDuration?: string; + /** + * The number of attempts that the system will make to run a job using the + * exponential backoff procedure described by max_doublings. The default + * value of retry_count is zero. If retry_count is zero, a job attempt will + * *not* be retried if it fails. Instead the Cloud Scheduler system will + * wait for the next scheduled execution time. If retry_count is set to a + * non-zero number then Cloud Scheduler will retry failed attempts, using + * exponential backoff, retry_count times, or until the next scheduled + * execution time, whichever comes first. Values greater than 5 and + * negative values are not allowed. + */ + retryCount?: number; + } + /** + * Request message for forcing a job to run now using RunJob. + */ + 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. + */ + 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$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; + jobs: Resource$Projects$Locations$Jobs; + constructor(context: APIRequestContext) { + this.context = context; + this.jobs = new Resource$Projects$Locations$Jobs(this.context); + } + + + /** + * cloudscheduler.projects.locations.get + * @desc Gets information about a location. + * @alias cloudscheduler.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://cloudscheduler.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); + } + } + + + /** + * cloudscheduler.projects.locations.list + * @desc Lists information about the supported locations for this service. + * @alias cloudscheduler.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://cloudscheduler.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; + } + + export class Resource$Projects$Locations$Jobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + + /** + * cloudscheduler.projects.locations.jobs.create + * @desc Creates a job. + * @alias cloudscheduler.projects.locations.jobs.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. + * @param {().Job} 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$Jobs$Create, + options?: MethodOptions): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Jobs$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Projects$Locations$Jobs$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/jobs') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudscheduler.projects.locations.jobs.delete + * @desc Deletes a job. + * @alias cloudscheduler.projects.locations.jobs.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_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$Projects$Locations$Jobs$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Jobs$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Projects$Locations$Jobs$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.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); + } + } + + + /** + * cloudscheduler.projects.locations.jobs.get + * @desc Gets a job. + * @alias cloudscheduler.projects.locations.jobs.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_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$Jobs$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Projects$Locations$Jobs$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Locations$Jobs$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.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); + } + } + + + /** + * cloudscheduler.projects.locations.jobs.list + * @desc Lists jobs. + * @alias cloudscheduler.projects.locations.jobs.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Requested page size. The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist. + * @param {string=} params.pageToken A token identifying a page of results the server will 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 ListJobs. It is an error to switch the value of filter or order_by while iterating through pages. + * @param {string} params.parent Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Jobs$List, + options?: MethodOptions): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Jobs$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$Locations$Jobs$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/jobs') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * 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. + * @alias cloudscheduler.projects.locations.jobs.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name 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. + * @param {string=} params.updateMask A mask used to specify which fields of the job are being updated. + * @param {().Job} 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$Jobs$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Jobs$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Projects$Locations$Jobs$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.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); + } + } + + + /** + * 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. + * @alias cloudscheduler.projects.locations.jobs.pause + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * @param {().PauseJobRequest} 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 + */ + pause( + params?: Params$Resource$Projects$Locations$Jobs$Pause, + options?: MethodOptions): GaxiosPromise; + pause( + params: Params$Resource$Projects$Locations$Jobs$Pause, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + pause( + params: Params$Resource$Projects$Locations$Jobs$Pause, + callback: BodyResponseCallback): void; + pause(callback: BodyResponseCallback): void; + pause( + paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$Pause| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$Pause; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Pause; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + '/v1/{+name}:pause').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * 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. + * @alias cloudscheduler.projects.locations.jobs.resume + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * @param {().ResumeJobRequest} 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 + */ + resume( + params?: Params$Resource$Projects$Locations$Jobs$Resume, + options?: MethodOptions): GaxiosPromise; + resume( + params: Params$Resource$Projects$Locations$Jobs$Resume, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + resume( + params: Params$Resource$Projects$Locations$Jobs$Resume, + callback: BodyResponseCallback): void; + resume(callback: BodyResponseCallback): void; + resume( + paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$Resume| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$Resume; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Resume; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:resume') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * 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. + * @alias cloudscheduler.projects.locations.jobs.run + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * @param {().RunJobRequest} 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 + */ + run(params?: Params$Resource$Projects$Locations$Jobs$Run, + options?: MethodOptions): GaxiosPromise; + run(params: Params$Resource$Projects$Locations$Jobs$Run, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + run(params: Params$Resource$Projects$Locations$Jobs$Run, + callback: BodyResponseCallback): void; + run(callback: BodyResponseCallback): void; + run(paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$Run| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$Run; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Run; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:run').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$Jobs$Create extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The location name. For example: + * `projects/PROJECT_ID/locations/LOCATION_ID`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Job; + } + export interface Params$Resource$Projects$Locations$Jobs$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The job name. For example: + * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Jobs$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The job name. For example: + * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Jobs$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Requested page size. The maximum page size is 500. If unspecified, the + * page size will be the maximum. Fewer jobs than requested might be + * returned, even if more jobs exist; use next_page_token to determine if + * more jobs exist. + */ + pageSize?: number; + /** + * A token identifying a page of results the server will 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 ListJobs. It is an error to switch the value of + * filter or order_by while iterating through pages. + */ + pageToken?: string; + /** + * Required. The location name. For example: + * `projects/PROJECT_ID/locations/LOCATION_ID`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Jobs$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * 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?: string; + /** + * A mask used to specify which fields of the job are being updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Job; + } + export interface Params$Resource$Projects$Locations$Jobs$Pause extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The job name. For example: + * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PauseJobRequest; + } + export interface Params$Resource$Projects$Locations$Jobs$Resume extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The job name. For example: + * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResumeJobRequest; + } + export interface Params$Resource$Projects$Locations$Jobs$Run extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The job name. For example: + * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RunJobRequest; + } +} diff --git a/src/apis/cloudsearch/v1.ts b/src/apis/cloudsearch/v1.ts index 7bd8a8ea745..6e2f8fb865a 100644 --- a/src/apis/cloudsearch/v1.ts +++ b/src/apis/cloudsearch/v1.ts @@ -258,7 +258,10 @@ export namespace cloudsearch_v1 { * Filter options restricting the results. If multiple filters are present, * they are grouped by object type before joining. Filters with the same * object type are joined conjunctively, then the resulting expressions are - * joined disjunctively. The maximum number of elements is 20. + * joined disjunctively. The maximum number of elements is 20. NOTE: + * Suggest API supports only few filters at the moment: + * "objecttype", "type" and "mimetype". For + * now, schema specific filters cannot be used to filter suggestions. */ filterOptions?: Schema$FilterOptions[]; /** @@ -348,8 +351,8 @@ export namespace cloudsearch_v1 { */ export interface Schema$DebugOptions { /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ enableDebugging?: boolean; } @@ -1415,7 +1418,7 @@ export namespace cloudsearch_v1 { response?: {[key: string]: any;}; } /** - * A people suggestion. + * This field contains information about the person being suggested. */ export interface Schema$PeopleSuggestion { /** @@ -1783,7 +1786,8 @@ export namespace cloudsearch_v1 { source?: Schema$Source; } /** - * A completed query suggestion. + * This field does not contain anything as of now and is just used as an + * indicator that the suggest result was a phrase completion. */ export interface Schema$QuerySuggestion {} /** @@ -1816,7 +1820,9 @@ export namespace cloudsearch_v1 { * 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. For - * translations. + * translations. When specified, the documents in search results are biased + * towards the specified language. Suggest API does not use this parameter. + * It autocompletes only based on characters in the query. */ languageCode?: string; /** @@ -2380,11 +2386,14 @@ export namespace cloudsearch_v1 { export interface Schema$SuggestRequest { /** * The sources to use for suggestions. If not specified, all data sources - * from the current search application are used. + * from the current search application are used. Suggestions are based on + * Gmail titles. Suggestions from third party sources are not available. */ dataSourceRestrictions?: Schema$DataSourceRestriction[]; /** - * Partial query for the completion suggestion. + * Partial query for which autocomplete suggestions will be shown. For + * example, if the query is "sea", then the server might return + * "season", "search", "seagull" and so on. */ query?: string; /** @@ -2397,7 +2406,7 @@ export namespace cloudsearch_v1 { */ export interface Schema$SuggestResponse { /** - * List of suggestion results. + * List of suggestions. */ suggestResults?: Schema$SuggestResult[]; } @@ -2405,7 +2414,15 @@ export namespace cloudsearch_v1 { * One suggestion result. */ export interface Schema$SuggestResult { + /** + * This is present when the suggestion indicates a person. It contains more + * information about the person - like their email ID, name etc. + */ peopleSuggestion?: Schema$PeopleSuggestion; + /** + * This field will be present if the suggested query is a word/phrase + * completion. + */ querySuggestion?: Schema$QuerySuggestion; /** * The source of the suggestion. @@ -2652,7 +2669,7 @@ export namespace cloudsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {string} params.name Item name, format: datasources/{source_id}/items/{item_id} * @param {().Principal} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2801,8 +2818,8 @@ export namespace cloudsearch_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -2847,7 +2864,7 @@ export namespace cloudsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {integer=} params.pageSize Maximum number of items to fetch in a request. Defaults to 100. * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. * @param {string} params.parent The name of the item, in the following format: datasources/{source_id}/items/{ID} @@ -2926,8 +2943,8 @@ export namespace cloudsearch_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -2974,7 +2991,7 @@ export namespace cloudsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {string=} params.groupResourceName * @param {integer=} params.pageSize Maximum number of items to fetch in a request. Defaults to 100. * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. @@ -3061,8 +3078,8 @@ export namespace cloudsearch_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -3103,7 +3120,7 @@ export namespace cloudsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {integer=} params.pageSize Maximum number of items to fetch in a request. Defaults to 100. * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. * @param {string} params.parent The name of the identity source, in the following format: identitysources/{source_id} @@ -3183,8 +3200,8 @@ export namespace cloudsearch_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -3234,7 +3251,7 @@ export namespace cloudsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {string} params.name Name of the data source to delete Schema. Format: datasources/{source_id} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3302,7 +3319,7 @@ export namespace cloudsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {string} params.name Name of the data source to get Schema. Format: datasources/{source_id} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3438,8 +3455,8 @@ export namespace cloudsearch_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -3456,8 +3473,8 @@ export namespace cloudsearch_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -3499,7 +3516,7 @@ export namespace cloudsearch_v1 { * * @param {object} params Parameters for request * @param {string=} params.connectorName Name of connector making this call.
                          Format: datasources/{source_id}/connectors/{ID} - * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {string=} params.mode Required. The RequestMode for this request. * @param {string} params.name Required. Name of the item to delete. Format: datasources/{source_id}/items/{item_id} * @param {string=} params.version Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering.

                          Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. @@ -3641,7 +3658,7 @@ export namespace cloudsearch_v1 { * * @param {object} params Parameters for request * @param {string=} params.connectorName Name of connector making this call.
                          Format: datasources/{source_id}/connectors/{ID} - * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {string} params.name Name of the item to get info. Format: datasources/{source_id}/items/{item_id} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3776,7 +3793,7 @@ export namespace cloudsearch_v1 { * @param {object} params Parameters for request * @param {boolean=} params.brief When set to true, the indexing system only populates the following fields: name, version, metadata.hash, structured_data.hash, content.hash.
                          If this value is false, then all the fields are populated in Item. * @param {string=} params.connectorName Name of connector making this call.
                          Format: datasources/{source_id}/connectors/{ID} - * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {string} params.name Name of the Data Source to list Items. Format: datasources/{source_id} * @param {integer=} params.pageSize Maximum number of items to fetch in a request. The max value is 1000 when brief is true. The max value is 10 if brief is false.
                          The default value is 10 * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. @@ -4135,8 +4152,8 @@ export namespace cloudsearch_v1 { */ connectorName?: string; /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -4190,8 +4207,8 @@ export namespace cloudsearch_v1 { */ connectorName?: string; /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -4237,8 +4254,8 @@ export namespace cloudsearch_v1 { */ connectorName?: string; /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -4714,8 +4731,8 @@ export namespace cloudsearch_v1 { * * @param {object} params Parameters for request * @param {string=} params.pageToken Number of sources to return in the response. - * @param {boolean=} params.requestOptions.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. - * @param {string=} params.requestOptions.languageCode 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. For translations. + * @param {boolean=} params.requestOptions.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. + * @param {string=} params.requestOptions.languageCode 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. For translations. When specified, the documents in search results are biased towards the specified language. Suggest API does not use this parameter. It autocompletes only based on characters in the query. * @param {string=} params.requestOptions.searchApplicationId Id of the application created using SearchApplicationsService. * @param {string=} params.requestOptions.timeZone Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml) * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4789,15 +4806,17 @@ export namespace cloudsearch_v1 { */ pageToken?: string; /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ 'requestOptions.debugOptions.enableDebugging'?: boolean; /** * 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. For - * translations. + * translations. When specified, the documents in search results are biased + * towards the specified language. Suggest API does not use this parameter. + * It autocompletes only based on characters in the query. */ 'requestOptions.languageCode'?: string; /** @@ -4910,7 +4929,7 @@ export namespace cloudsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {string} params.name Name of the datasource. Format: datasources/{source_id}. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4978,7 +4997,7 @@ export namespace cloudsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {string} params.name Name of the datasource resource. Format: datasources/{source_id}. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5042,7 +5061,7 @@ export namespace cloudsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {integer=} params.pageSize Maximum number of datasources to fetch in a request. The max value is 100.
                          The default value is 10 * @param {string=} params.pageToken Starting index of the results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5194,8 +5213,8 @@ export namespace cloudsearch_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -5211,8 +5230,8 @@ export namespace cloudsearch_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -5228,8 +5247,8 @@ export namespace cloudsearch_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -5343,7 +5362,7 @@ export namespace cloudsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {string} params.name The name of the search application to be deleted.
                          Format: applications/{application_id}. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5411,7 +5430,7 @@ export namespace cloudsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {string} params.name Name of the search application.
                          Format: applications/{application_id}. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5475,7 +5494,7 @@ export namespace cloudsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {integer=} params.pageSize The maximum number of items to return. * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any.
                          The default value is 10 * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5702,8 +5721,8 @@ export namespace cloudsearch_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -5720,8 +5739,8 @@ export namespace cloudsearch_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** @@ -5738,8 +5757,8 @@ export namespace cloudsearch_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * If set, the request will enable debugging features of Cloud Search. Only - * turn on this field, if asked by Google to help with debugging. + * If you are asked by Google to help with debugging, set this field. + * Otherwise, ignore this field. */ 'debugOptions.enableDebugging'?: boolean; /** diff --git a/src/apis/cloudtasks/v2.ts b/src/apis/cloudtasks/v2.ts index b3bfe359b0b..a946dc2c808 100644 --- a/src/apis/cloudtasks/v2.ts +++ b/src/apis/cloudtasks/v2.ts @@ -289,7 +289,7 @@ export namespace cloudtasks_v2 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index dc8d4cf4526..bb0b3ef1faa 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -342,7 +342,7 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index d54be3e4630..d3a05ee93b2 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -307,7 +307,7 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/commentanalyzer/README.md b/src/apis/commentanalyzer/README.md new file mode 100644 index 00000000000..4cb8e6d1530 --- /dev/null +++ b/src/apis/commentanalyzer/README.md @@ -0,0 +1,47 @@ +Google Inc. logo + +# commentanalyzer + +> The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned. + +## 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/commentanalyzer +$ npm install +$ npm run webpack +``` + +The generated bundle will be written to `dist/commentanalyzer.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/commentanalyzer/index.ts b/src/apis/commentanalyzer/index.ts new file mode 100644 index 00000000000..8e6d2c6cb9b --- /dev/null +++ b/src/apis/commentanalyzer/index.ts @@ -0,0 +1,34 @@ +// 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 {commentanalyzer_v1alpha1} from './v1alpha1'; + +export const VERSIONS = { + 'v1alpha1': commentanalyzer_v1alpha1.Commentanalyzer, +}; + +export function commentanalyzer(version: 'v1alpha1'): + commentanalyzer_v1alpha1.Commentanalyzer; +export function commentanalyzer(options: commentanalyzer_v1alpha1.Options): + commentanalyzer_v1alpha1.Commentanalyzer; +export function commentanalyzer( + this: GoogleConfigurable, + versionOrOptions: 'v1alpha1'|commentanalyzer_v1alpha1.Options) { + return getAPI('commentanalyzer', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; diff --git a/src/apis/commentanalyzer/package.json b/src/apis/commentanalyzer/package.json new file mode 100644 index 00000000000..db2e950ba1b --- /dev/null +++ b/src/apis/commentanalyzer/package.json @@ -0,0 +1,43 @@ +{ + "name": "@google/commentanalyzer", + "version": "0.1.0", + "description": "commentanalyzer", + "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": ">=6.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": "^0.7.0" + }, + "devDependencies": { + "gts": "^0.9.0", + "null-loader": "^0.1.1", + "ts-loader": "^5.3.3", + "typedoc": "^0.14.0", + "typescript": "~3.4.0", + "webpack": "^4.28.4", + "webpack-cli": "^3.2.1" + } +} diff --git a/src/apis/commentanalyzer/tsconfig.json b/src/apis/commentanalyzer/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/commentanalyzer/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/commentanalyzer/v1alpha1.ts b/src/apis/commentanalyzer/v1alpha1.ts new file mode 100644 index 00000000000..ae14b9af6e1 --- /dev/null +++ b/src/apis/commentanalyzer/v1alpha1.ts @@ -0,0 +1,574 @@ +/** + * 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 {GaxiosPromise} from 'gaxios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; +import {APIRequestContext, BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace commentanalyzer_v1alpha1 { + export interface Options extends GlobalOptions { + version: 'v1alpha1'; + } + + 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; + } + + /** + * Perspective Comment Analyzer API + * + * The Perspective Comment Analyzer API provides information about the + * potential impact of a comment on a conversation (e.g. it can provide a + * score for the "toxicity" of a comment). Users can leverage the + * "SuggestCommentScore" method to submit corrections to improve + * Perspective over time. Users can set the "doNotStore" flag to + * ensure that all submitted comments are automatically deleted after scores + * are returned. + * + * @example + * const {google} = require('googleapis'); + * const commentanalyzer = google.commentanalyzer('v1alpha1'); + * + * @namespace commentanalyzer + * @type {Function} + * @version v1alpha1 + * @variation v1alpha1 + * @param {object=} options Options for Commentanalyzer + */ + export class Commentanalyzer { + context: APIRequestContext; + comments: Resource$Comments; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = {_options: options || {}, google}; + + this.comments = new Resource$Comments(this.context); + } + } + + /** + * The comment analysis request message. + */ + export interface Schema$AnalyzeCommentRequest { + /** + * Opaque token that is echoed from the request to the response. + */ + clientToken?: string; + /** + * The comment to analyze. + */ + comment?: Schema$TextEntry; + /** + * Optional identifier associating this AnalyzeCommentRequest with a + * particular client's community. Different communities may have + * different norms and rules. Specifying this value enables us to explore + * building community-specific models for clients. + */ + communityId?: string; + /** + * The context of the comment. + */ + context?: Schema$Context; + /** + * Do not store the comment or context sent in this request. By default, the + * service may store comments/context for debugging purposes. + */ + doNotStore?: boolean; + /** + * The language(s) of the comment and context (if none are specified, the + * language is automatically detected). If multiple languages are specified, + * the text is checked in all of them that are supported. Both ISO and + * BCP-47 language codes are accepted. Current Language Restrictions: * + * Only English text ("en") is supported. If none of the languages + * specified by the caller are supported, an `UNIMPLEMENTED` error is + * returned. + */ + languages?: string[]; + /** + * Specification of requested attributes. The AttributeParameters serve as + * configuration for each associated attribute. The map keys are attribute + * names. The following attributes are available: + * "ATTACK_ON_AUTHOR" - Attack on author of original article or + * post. "ATTACK_ON_COMMENTER" - Attack on fellow commenter. + * "ATTACK_ON_PUBLISHER" - Attack on publisher of article/post. + * "INCOHERENT" - Difficult to understand, nonsensical. + * "INFLAMMATORY" - Intending to provoke or inflame. + * "OBSCENE" - Obscene, such as cursing. "OFF_TOPIC" - + * Not related to the original topic. "SPAM" - + * Commercial/advertising spam content. "UNSUBSTANTIAL" - Trivial. + */ + requestedAttributes?: {[key: string]: Schema$AttributeParameters;}; + /** + * Session ID. Used to join related RPCs into a single session. For example, + * an interactive tool that calls both the AnalyzeComment and + * SuggestCommentScore RPCs should set all invocations of both RPCs to the + * same Session ID, typically a random 64-bit integer. + */ + sessionId?: string; + /** + * An advisory parameter that will return span annotations if the model is + * capable of providing scores with sub-comment resolution. This will likely + * increase the size of the returned message. + */ + spanAnnotations?: boolean; + } + /** + * The comment analysis response message. + */ + export interface Schema$AnalyzeCommentResponse { + /** + * Scores for the requested attributes. The map keys are attribute names + * (same as the requested_attribute field in AnalyzeCommentRequest, for + * example "ATTACK_ON_AUTHOR", "INFLAMMATORY", etc). + */ + attributeScores?: {[key: string]: Schema$AttributeScores;}; + /** + * Same token from the original AnalyzeCommentRequest. + */ + 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. + */ + 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. + */ + languages?: string[]; + } + /** + * A type of context specific to a comment left on a single-threaded comment + * message board, where comments are either a top level comment or the child + * of a top level comment. + */ + export interface Schema$ArticleAndParentComment { + /** + * The source content about which the comment was made (article text, + * article summary, video transcript, etc). + */ + article?: Schema$TextEntry; + /** + * Refers to text that is a direct parent of the source comment, such as in + * a one-deep threaded message board. This field will only be present for + * comments that are replies to other comments and will not be populated for + * direct comments on the article_text. + */ + parentComment?: Schema$TextEntry; + } + /** + * Configurable parameters for attribute scoring. + */ + export interface Schema$AttributeParameters { + /** + * Don't return scores for this attribute that are below this threshold. + * If unset, a default threshold will be applied. A FloatValue wrapper is + * used to distinguish between 0 vs. default/unset. + */ + scoreThreshold?: number; + /** + * What type of scores to return. If unset, defaults to probability scores. + */ + scoreType?: string; + } + /** + * This holds score values for a single attribute. It contains both per-span + * scores as well as an overall summary score.. + */ + export interface Schema$AttributeScores { + /** + * Per-span scores. + */ + spanScores?: Schema$SpanScore[]; + /** + * Overall score for comment as a whole. + */ + summaryScore?: Schema$Score; + } + /** + * Context is typically something that a Comment is referencing or replying to + * (such as an article, or previous comment). Note: Populate only ONE OF the + * following fields. The oneof syntax cannot be used because that would + * require nesting entries inside another message and breaking backwards + * compatibility. The server will return an error if more than one of the + * following fields is present. + */ + export interface Schema$Context { + /** + * Information about the source for which the original comment was made, and + * any parent comment info. + */ + articleAndParentComment?: Schema$ArticleAndParentComment; + /** + * A list of messages. For example, a linear comments section or forum + * thread. + */ + entries?: Schema$TextEntry[]; + } + /** + * Analysis scores are described by a value and a ScoreType. + */ + export interface Schema$Score { + /** + * The type of the above value. + */ + type?: string; + /** + * Score value. Semantics described by type below. + */ + value?: number; + } + /** + * This is a single score for a given span of text. + */ + export interface Schema$SpanScore { + /** + * "begin" and "end" describe the span of the original + * text that the attribute score applies to. The values are the UTF-16 + * codepoint range. "end" is exclusive. For example, with the text + * "Hi there", the begin/end pair (0,2) describes the text + * "Hi". If "begin" and "end" are unset, the + * score applies to the full text. + */ + begin?: number; + end?: number; + /** + * The score value. + */ + score?: Schema$Score; + } + /** + * The comment score suggestion request message. + */ + export interface Schema$SuggestCommentScoreRequest { + /** + * Attribute scores for the comment. The map keys are attribute names, same + * as the requested_attribute field in AnalyzeCommentRequest (for example + * "ATTACK_ON_AUTHOR", "INFLAMMATORY", etc.). This field + * has the same type as the `attribute_scores` field in + * AnalyzeCommentResponse. To specify an overall attribute score for the + * entire comment as a whole, use the `summary_score` field of the mapped + * AttributeScores object. To specify scores on specific subparts of the + * comment, use the `span_scores` field. All SpanScore objects must have + * begin and end fields set. All Score objects must be explicitly set (for + * binary classification, use the score values 0 and 1). If Score objects + * don't include a ScoreType, `PROBABILITY` is assumed. + * `attribute_scores` must not be empty. The mapped AttributeScores objects + * also must not be empty. An `INVALID_ARGUMENT` error is returned for all + * malformed requests. + */ + attributeScores?: {[key: string]: Schema$AttributeScores;}; + /** + * Opaque token that is echoed from the request to the response. + */ + clientToken?: string; + /** + * The comment being scored. + */ + comment?: Schema$TextEntry; + /** + * Optional identifier associating this comment score suggestion with a + * particular sub-community. Different communities may have different norms + * and rules. Specifying this value enables training community-specific + * models. + */ + communityId?: string; + /** + * The context of the comment. + */ + context?: Schema$Context; + /** + * The language(s) of the comment and context (if none are specified, the + * language is automatically detected). If multiple languages are specified, + * the text is checked in all of them that are supported. Both ISO and + * BCP-47 language codes are accepted. Current Language Restrictions: * + * Only English text ("en") is supported. If none of the languages + * specified by the caller are supported, an `UNIMPLEMENTED` error is + * returned. + */ + languages?: string[]; + /** + * Session ID. Used to join related RPCs into a single session. For example, + * an interactive tool that calls both the AnalyzeComment and + * SuggestCommentScore RPCs should set all invocations of both RPCs to the + * same Session ID, typically a random 64-bit integer. + */ + sessionId?: string; + } + /** + * The comment score suggestion response message. + */ + export interface Schema$SuggestCommentScoreResponse { + /** + * Same token from the original SuggestCommentScoreRequest. + */ + clientToken?: string; + /** + * The list of languages detected from the comment text. + */ + detectedLanguages?: string[]; + /** + * The list of languages provided in the request. + */ + requestedLanguages?: string[]; + } + /** + * Represents a body of text. + */ + export interface Schema$TextEntry { + /** + * UTF-8 encoded text. + */ + text?: string; + /** + * Type of the text field. + */ + type?: string; + } + + + export class Resource$Comments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + + /** + * commentanalyzer.comments.analyze + * @desc Analyzes the provided text and returns scores for requested + * attributes. + * @alias commentanalyzer.comments.analyze + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().AnalyzeCommentRequest} 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 + */ + analyze(params?: Params$Resource$Comments$Analyze, options?: MethodOptions): + GaxiosPromise; + analyze( + params: Params$Resource$Comments$Analyze, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + analyze( + params: Params$Resource$Comments$Analyze, + callback: BodyResponseCallback): void; + analyze(callback: BodyResponseCallback): + void; + analyze( + paramsOrCallback?: Params$Resource$Comments$Analyze| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Comments$Analyze; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Comments$Analyze; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://commentanalyzer.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/comments:analyze') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * commentanalyzer.comments.suggestscore + * @desc Suggest comment scores as training data. + * @alias commentanalyzer.comments.suggestscore + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().SuggestCommentScoreRequest} 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 + */ + suggestscore( + params?: Params$Resource$Comments$Suggestscore, + options?: MethodOptions): + GaxiosPromise; + suggestscore( + params: Params$Resource$Comments$Suggestscore, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + suggestscore( + params: Params$Resource$Comments$Suggestscore, + callback: BodyResponseCallback): + void; + suggestscore(callback: + BodyResponseCallback): + void; + suggestscore( + paramsOrCallback?: Params$Resource$Comments$Suggestscore| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Comments$Suggestscore; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Comments$Suggestscore; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://commentanalyzer.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/comments:suggestscore') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Comments$Analyze extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + + /** + * Request body metadata + */ + requestBody?: Schema$AnalyzeCommentRequest; + } + export interface Params$Resource$Comments$Suggestscore extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + + /** + * Request body metadata + */ + requestBody?: Schema$SuggestCommentScoreRequest; + } +} diff --git a/src/apis/commentanalyzer/webpack.config.js b/src/apis/commentanalyzer/webpack.config.js new file mode 100644 index 00000000000..7dcaef73cc7 --- /dev/null +++ b/src/apis/commentanalyzer/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: 'Commentanalyzer', + filename: 'commentanalyzer.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/compute/alpha.ts b/src/apis/compute/alpha.ts index 5bb32b77393..0aea8a31214 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -92,6 +92,7 @@ export namespace compute_alpha { forwardingRules: Resource$Forwardingrules; globalAddresses: Resource$Globaladdresses; globalForwardingRules: Resource$Globalforwardingrules; + globalNetworkEndpointGroups: Resource$Globalnetworkendpointgroups; globalOperations: Resource$Globaloperations; globalOrganizationOperations: Resource$Globalorganizationoperations; healthChecks: Resource$Healthchecks; @@ -170,6 +171,8 @@ export namespace compute_alpha { this.globalAddresses = new Resource$Globaladdresses(this.context); this.globalForwardingRules = new Resource$Globalforwardingrules(this.context); + this.globalNetworkEndpointGroups = + new Resource$Globalnetworkendpointgroups(this.context); this.globalOperations = new Resource$Globaloperations(this.context); this.globalOrganizationOperations = new Resource$Globalorganizationoperations(this.context); @@ -917,6 +920,12 @@ export namespace compute_alpha { * for regional resources. */ replicaZones?: 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 @@ -2122,7 +2131,7 @@ export namespace compute_alpha { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ @@ -3700,7 +3709,7 @@ export namespace compute_alpha { export interface Schema$FixedOrPercent { /** * [Output Only] Absolute value of VM instances calculated based on the - * specific mode. - If the value is fixed, then the caculated value is + * specific mode. - If the value is fixed, then the calculated value is * equal to the fixed value. - If the value is a percent, then the * calculated value is percent/100 * targetSize. For example, the calculated * value of a 80% of a managed instance group with 150 instances would be @@ -4050,6 +4059,18 @@ export namespace compute_alpha { message?: string; }; } + export interface Schema$GlobalNetworkEndpointGroupsAttachEndpointsRequest { + /** + * The list of network endpoints to be attached. + */ + networkEndpoints?: Schema$NetworkEndpoint[]; + } + export interface Schema$GlobalNetworkEndpointGroupsDetachEndpointsRequest { + /** + * The list of network endpoints to be detached. + */ + networkEndpoints?: Schema$NetworkEndpoint[]; + } export interface Schema$GlobalSetLabelsRequest { /** * The fingerprint of the previous set of labels for this resource, used to @@ -4242,9 +4263,10 @@ export namespace compute_alpha { */ timeoutSec?: number; /** - * Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If - * not specified, the default is TCP. Exactly one of the protocol-specific - * health check field must be specified, which must match type field. + * Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or + * HTTP2. If not specified, the default is TCP. Exactly one of the + * protocol-specific health check field must be specified, which must match + * type field. */ type?: string; udpHealthCheck?: Schema$UDPHealthCheck; @@ -6035,8 +6057,12 @@ export namespace compute_alpha { */ namedPorts?: Schema$NamedPort[]; /** - * [Output Only] The list of instance actions and the number of instances in - * this managed instance group that are pending for each of those actions. + * [Deprecated] This field is deprecated and will be removed. Prefer using + * the status field instead. Please contact + * cloud-updater-feedback@google.com to leave feedback if your workload + * relies on this field. [Output Only] The list of instance actions and the + * number of instances in this managed instance group that are pending for + * each of those actions. */ pendingActions?: Schema$InstanceGroupManagerPendingActionsSummary; /** @@ -6087,12 +6113,12 @@ export namespace compute_alpha { updatePolicy?: Schema$InstanceGroupManagerUpdatePolicy; /** * Specifies the instance templates used by this managed instance group to - * create instances. Each version is defined by an instanceTemplate. Every - * template can appear at most once per instance group. This field overrides - * the top-level instanceTemplate field. Read more about the relationships - * between these fields. Exactly one version must leave the targetSize field - * unset. That version will be applied to all remaining instances. For more - * information, read about canary updates. + * create instances. Each version is defined by an instanceTemplate and a + * name. Every version can appear at most once per instance group. This + * field overrides the top-level instanceTemplate field. Read more about the + * relationships between these fields. Exactly one version must leave the + * targetSize field unset. That version will be applied to all remaining + * instances. For more information, read about canary updates. */ versions?: Schema$InstanceGroupManagerVersion[]; /** @@ -6267,23 +6293,35 @@ export namespace compute_alpha { } export interface Schema$InstanceGroupManagerPendingActionsSummary { /** - * [Output Only] The number of instances in the managed instance group that - * are pending to be created. + * [Deprecated] This field is deprecated and will be removed. Prefer using + * the status field instead. Please contact + * cloud-updater-feedback@google.com to leave feedback if your workload + * relies on this field. [Output Only] The number of instances in the + * managed instance group that are pending to be created. */ creating?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are pending to be deleted. + * [Deprecated] This field is deprecated and will be removed. Prefer using + * the status field instead. Please contact + * cloud-updater-feedback@google.com to leave feedback if your workload + * relies on this field. [Output Only] The number of instances in the + * managed instance group that are pending to be deleted. */ deleting?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are pending to be recreated. + * [Deprecated] This field is deprecated and will be removed. Prefer using + * the status field instead. Please contact + * cloud-updater-feedback@google.com to leave feedback if your workload + * relies on this field. [Output Only] The number of instances in the + * managed instance group that are pending to be recreated. */ recreating?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are pending to be restarted. + * [Deprecated] This field is deprecated and will be removed. Prefer using + * the status field instead. Please contact + * cloud-updater-feedback@google.com to leave feedback if your workload + * relies on this field. [Output Only] The number of instances in the + * managed instance group that are pending to be restarted. */ restarting?: number; } @@ -6562,6 +6600,12 @@ export namespace compute_alpha { type?: string; } export interface Schema$InstanceGroupManagerVersion { + /** + * The URL of the instance template that is specified for this managed + * instance group. The group uses this template to create new instances in + * the managed instance group until the `targetSize` for this version is + * reached. + */ instanceTemplate?: string; /** * Name of the version. Unique among all versions in the scope of this @@ -6868,6 +6912,31 @@ export namespace compute_alpha { */ resourcePolicies?: string[]; } + export interface Schema$InstancesGetEffectiveFirewallsResponse { + /** + * Effective firewalls on the instance. + */ + firewalls?: Schema$Firewall[]; + /** + * Effective firewalls from organization policies. + */ + organizationFirewalls?: + Schema$InstancesGetEffectiveFirewallsResponseOrganizationFirewallPolicy[]; + } + /** + * A pruned SecurityPolicy containing ID and any applicable firewall rules. + */ + export interface Schema$InstancesGetEffectiveFirewallsResponseOrganizationFirewallPolicy { + /** + * The unique identifier for the security policy. This identifier is defined + * by the server. + */ + id?: string; + /** + * The rules that apply to the network. + */ + rules?: Schema$SecurityPolicyRule[]; + } export interface Schema$InstancesRemoveResourcePoliciesRequest { /** * Resource policies to be removed from this instance. @@ -8179,6 +8248,22 @@ export namespace compute_alpha { message?: string; }; } + export interface Schema$LocalDisk { + /** + * Specifies the number of such disks. + */ + diskCount?: string; + /** + * Specifies the size of the disk in base-2 GB. + */ + diskSizeGb?: string; + /** + * Specifies the desired disk type on the node. This disk type must be a + * local storage type (e.g.: local-ssd). Note that for nodeTemplates, this + * should be the name of the disk type and not its URL. + */ + diskType?: string; + } /** * Specifies what kind of log the caller must write */ @@ -8829,6 +8914,12 @@ export namespace compute_alpha { * [Output Only] Type of LB-to-VM traffic encryption for this network. */ loadBalancerVmEncryption?: string; + /** + * 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. @@ -9094,6 +9185,13 @@ export namespace compute_alpha { networkEndpoints?: Schema$NetworkEndpoint[]; } export interface Schema$NetworkEndpointGroupsListEndpointsRequest { + /** + * Optional list of endpoints to query. This is a more efficient but also + * limited version of filter parameter. Endpoints in the filter must have + * ip_address and port fields populated, other fields are not supported. + */ + endpointFilters?: + Schema$NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter[]; /** * Optional query parameter for showing the health status of each network * endpoint. Valid options are SKIP or SHOW. If you don't specifiy this @@ -9101,6 +9199,9 @@ export namespace compute_alpha { */ healthStatus?: string; } + export interface Schema$NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter { + networkEndpoint?: Schema$NetworkEndpoint; + } export interface Schema$NetworkEndpointGroupsListNetworkEndpoints { /** * [Output Only] Unique identifier for the resource; defined by the server. @@ -9395,6 +9496,31 @@ export namespace compute_alpha { */ peerNetwork?: string; } + export interface Schema$NetworksGetEffectiveFirewallsResponse { + /** + * Effective firewalls on the network. + */ + firewalls?: Schema$Firewall[]; + /** + * Effective firewalls from organization policies. + */ + organizationFirewalls?: + Schema$NetworksGetEffectiveFirewallsResponseOrganizationFirewallPolicy[]; + } + /** + * A pruned SecurityPolicy containing ID and any applicable firewall rules. + */ + export interface Schema$NetworksGetEffectiveFirewallsResponseOrganizationFirewallPolicy { + /** + * [Output Only] The unique identifier for the security policy. This + * identifier is defined by the server. + */ + id?: string; + /** + * The rules that apply to the network. + */ + rules?: Schema$SecurityPolicyRule[]; + } export interface Schema$NetworksRemovePeeringRequest { /** * Name of the peering, which should conform to RFC1035. @@ -9405,8 +9531,10 @@ export namespace compute_alpha { networkPeering?: Schema$NetworkPeering; } /** - * A NodeGroup resource. (== resource_for beta.nodeGroups ==) (== resource_for - * v1.nodeGroups ==) + * 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 ==) */ export interface Schema$NodeGroup { autoscalingPolicy?: Schema$NodeGroupAutoscalingPolicy; @@ -9429,6 +9557,7 @@ export namespace compute_alpha { * group. */ kind?: string; + managedHoldback?: 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 @@ -9540,6 +9669,10 @@ export namespace compute_alpha { }; } export interface Schema$NodeGroupNode { + /** + * Local disk configurations. + */ + disks?: Schema$LocalDisk[]; /** * Instances scheduled on this node. */ @@ -9629,7 +9762,9 @@ export namespace compute_alpha { nodeTemplate?: string; } /** - * A Node Template resource. + * 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 ==) */ export interface Schema$NodeTemplate { /** @@ -9641,6 +9776,7 @@ export namespace compute_alpha { * create the resource. */ description?: string; + disks?: Schema$LocalDisk[]; /** * [Output Only] The unique identifier for the resource. This identifier is * defined by the server. @@ -11728,6 +11864,10 @@ export namespace compute_alpha { * Resource policy for persistent disks for creating snapshots. */ snapshotSchedulePolicy?: Schema$ResourcePolicySnapshotSchedulePolicy; + /** + * [Output Only] The status of resource policy creation. + */ + status?: string; /** * Resource policy applicable to VMs for infrastructure maintenance. */ @@ -12053,6 +12193,12 @@ export namespace compute_alpha { * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ */ nextHopInstance?: string; + /** + * [Output Only] The URL to an InterconnectAttachment which is the next hop + * for the route. This field will only be populated for the dynamic routes + * generated by Cloud Router with a linked interconnectAttachment. + */ + nextHopInterconnectAttachment?: string; /** * The network IP address of an instance that should handle matching * packets. Only IPv4 is supported. @@ -12396,11 +12542,11 @@ export namespace compute_alpha { */ minTransmitInterval?: number; /** - * The BFD session initiation 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. + * 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. */ mode?: string; /** @@ -12921,6 +13067,13 @@ export namespace compute_alpha { * Compute Engine. */ automaticRestart?: boolean; + /** + * Defines whether the instance is tolerant of higher cpu latency. This can + * only be set during instance creation, or when the instance is not + * currently running. It must not be set if the preemptible option is also + * set. + */ + latencyTolerant?: boolean; /** * The minimum number of virtual CPUs this instance will consume when * running on a sole-tenant node. @@ -16894,7 +17047,7 @@ export namespace compute_alpha { } /** * A Zone resource. (== resource_for beta.zones ==) (== resource_for v1.zones - * ==) + * ==) Next ID: 17 */ export interface Schema$Zone { /** @@ -26877,116 +27030,920 @@ export namespace compute_alpha { */ project?: string; } - export interface Params$Resource$Globalforwardingrules$Patch extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Name of the ForwardingRule resource to patch. - */ - forwardingRule?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ForwardingRule; - } - export interface Params$Resource$Globalforwardingrules$Setlabels 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; - - /** - * Request body metadata - */ - requestBody?: Schema$GlobalSetLabelsRequest; - } - export interface Params$Resource$Globalforwardingrules$Settarget extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Name of the ForwardingRule resource in which target is to be set. - */ - forwardingRule?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TargetReference; - } - export interface Params$Resource$Globalforwardingrules$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; - - /** - * Request body metadata - */ - requestBody?: Schema$TestPermissionsRequest; - } + export interface Params$Resource$Globalforwardingrules$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the ForwardingRule resource to patch. + */ + forwardingRule?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ForwardingRule; + } + export interface Params$Resource$Globalforwardingrules$Setlabels 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; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetLabelsRequest; + } + export interface Params$Resource$Globalforwardingrules$Settarget extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the ForwardingRule resource in which target is to be set. + */ + forwardingRule?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetReference; + } + export interface Params$Resource$Globalforwardingrules$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; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + + export class Resource$Globalnetworkendpointgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + + /** + * compute.globalNetworkEndpointGroups.attachNetworkEndpoints + * @desc Attach a network endpoint to the specified network endpoint group. + * @alias compute.globalNetworkEndpointGroups.attachNetworkEndpoints + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.networkEndpointGroup The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().GlobalNetworkEndpointGroupsAttachEndpointsRequest} 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 + */ + attachNetworkEndpoints( + params?: + Params$Resource$Globalnetworkendpointgroups$Attachnetworkendpoints, + options?: MethodOptions): GaxiosPromise; + attachNetworkEndpoints( + params: + Params$Resource$Globalnetworkendpointgroups$Attachnetworkendpoints, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + attachNetworkEndpoints( + params: + Params$Resource$Globalnetworkendpointgroups$Attachnetworkendpoints, + callback: BodyResponseCallback): void; + attachNetworkEndpoints(callback: BodyResponseCallback): + void; + attachNetworkEndpoints( + paramsOrCallback?: + Params$Resource$Globalnetworkendpointgroups$Attachnetworkendpoints| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Globalnetworkendpointgroups$Attachnetworkendpoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Globalnetworkendpointgroups$Attachnetworkendpoints; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.globalNetworkEndpointGroups.delete + * @desc Deletes the specified network endpoint group.Note that the NEG + * cannot be deleted if there are backend services referencing it. + * @alias compute.globalNetworkEndpointGroups.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.networkEndpointGroup The name of the network endpoint group to delete. It should comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [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$Globalnetworkendpointgroups$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: Params$Resource$Globalnetworkendpointgroups$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Globalnetworkendpointgroups$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Globalnetworkendpointgroups$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Globalnetworkendpointgroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalnetworkendpointgroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['project', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.globalNetworkEndpointGroups.detachNetworkEndpoints + * @desc Detach the network endpoint from the specified network endpoint + * group. + * @alias compute.globalNetworkEndpointGroups.detachNetworkEndpoints + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.networkEndpointGroup The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().GlobalNetworkEndpointGroupsDetachEndpointsRequest} 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 + */ + detachNetworkEndpoints( + params?: + Params$Resource$Globalnetworkendpointgroups$Detachnetworkendpoints, + options?: MethodOptions): GaxiosPromise; + detachNetworkEndpoints( + params: + Params$Resource$Globalnetworkendpointgroups$Detachnetworkendpoints, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + detachNetworkEndpoints( + params: + Params$Resource$Globalnetworkendpointgroups$Detachnetworkendpoints, + callback: BodyResponseCallback): void; + detachNetworkEndpoints(callback: BodyResponseCallback): + void; + detachNetworkEndpoints( + paramsOrCallback?: + Params$Resource$Globalnetworkendpointgroups$Detachnetworkendpoints| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Globalnetworkendpointgroups$Detachnetworkendpoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Globalnetworkendpointgroups$Detachnetworkendpoints; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.globalNetworkEndpointGroups.get + * @desc Returns the specified network endpoint group. Gets a list of + * available network endpoint groups by making a list() request. + * @alias compute.globalNetworkEndpointGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.networkEndpointGroup The name of the network endpoint group. It should comply with RFC1035. + * @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$Globalnetworkendpointgroups$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Globalnetworkendpointgroups$Get, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Globalnetworkendpointgroups$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Globalnetworkendpointgroups$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Globalnetworkendpointgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalnetworkendpointgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.globalNetworkEndpointGroups.insert + * @desc Creates a network endpoint group in the specified project using the + * parameters that are included in the request. + * @alias compute.globalNetworkEndpointGroups.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 {().NetworkEndpointGroup} 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$Globalnetworkendpointgroups$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Globalnetworkendpointgroups$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Globalnetworkendpointgroups$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Globalnetworkendpointgroups$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Globalnetworkendpointgroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalnetworkendpointgroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/global/networkEndpointGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.globalNetworkEndpointGroups.list + * @desc Retrieves the list of network endpoint groups that are located in + * the specified project. + * @alias compute.globalNetworkEndpointGroups.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 + */ + list( + params?: Params$Resource$Globalnetworkendpointgroups$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Globalnetworkendpointgroups$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Globalnetworkendpointgroups$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Globalnetworkendpointgroups$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Globalnetworkendpointgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalnetworkendpointgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/global/networkEndpointGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.globalNetworkEndpointGroups.listNetworkEndpoints + * @desc Lists the network endpoints in the specified network endpoint + * group. + * @alias compute.globalNetworkEndpointGroups.listNetworkEndpoints + * @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.networkEndpointGroup The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. + * @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 + */ + listNetworkEndpoints( + params?: + Params$Resource$Globalnetworkendpointgroups$Listnetworkendpoints, + options?: MethodOptions): + GaxiosPromise; + listNetworkEndpoints( + params: + Params$Resource$Globalnetworkendpointgroups$Listnetworkendpoints, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints>): void; + listNetworkEndpoints( + params: + Params$Resource$Globalnetworkendpointgroups$Listnetworkendpoints, + callback: BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints>): void; + listNetworkEndpoints(callback: BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints>): + void; + listNetworkEndpoints( + paramsOrCallback?: + Params$Resource$Globalnetworkendpointgroups$Listnetworkendpoints| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints>): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Globalnetworkendpointgroups$Listnetworkendpoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Globalnetworkendpointgroups$Listnetworkendpoints; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project'], + context: this.context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest< + Schema$NetworkEndpointGroupsListNetworkEndpoints>(parameters); + } + } + } + + export interface Params$Resource$Globalnetworkendpointgroups$Attachnetworkendpoints + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the network endpoint group where you are attaching network + * endpoints to. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalNetworkEndpointGroupsAttachEndpointsRequest; + } + export interface Params$Resource$Globalnetworkendpointgroups$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the network endpoint group to delete. It should comply with + * RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Globalnetworkendpointgroups$Detachnetworkendpoints + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the network endpoint group where you are removing network + * endpoints. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalNetworkEndpointGroupsDetachEndpointsRequest; + } + export interface Params$Resource$Globalnetworkendpointgroups$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the network endpoint group. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Globalnetworkendpointgroups$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; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkEndpointGroup; + } + export interface Params$Resource$Globalnetworkendpointgroups$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; + } + export interface Params$Resource$Globalnetworkendpointgroups$Listnetworkendpoints + 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; + /** + * The name of the network endpoint group from which you want to generate a + * list of included network endpoints. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } export class Resource$Globaloperations { @@ -35725,6 +36682,87 @@ export namespace compute_alpha { } + /** + * compute.instances.getEffectiveFirewalls + * @desc Returns effective firewalls applied to an interface of the + * instance. + * @alias compute.instances.getEffectiveFirewalls + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.networkInterface The name of the network interface to get the effective firewalls. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getEffectiveFirewalls( + params?: Params$Resource$Instances$Geteffectivefirewalls, + options?: MethodOptions): + GaxiosPromise; + getEffectiveFirewalls( + params: Params$Resource$Instances$Geteffectivefirewalls, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback< + Schema$InstancesGetEffectiveFirewallsResponse>): void; + getEffectiveFirewalls( + params: Params$Resource$Instances$Geteffectivefirewalls, + callback: BodyResponseCallback< + Schema$InstancesGetEffectiveFirewallsResponse>): void; + getEffectiveFirewalls(callback: BodyResponseCallback< + Schema$InstancesGetEffectiveFirewallsResponse>): void; + getEffectiveFirewalls( + paramsOrCallback?: Params$Resource$Instances$Geteffectivefirewalls| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$InstancesGetEffectiveFirewallsResponse>): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Instances$Geteffectivefirewalls; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Geteffectivefirewalls; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'zone', 'instance', 'networkInterface'], + pathParams: ['instance', 'project', 'zone'], + context: this.context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + /** * compute.instances.getGuestAttributes * @desc Returns the specified guest attributes entry. @@ -38637,6 +39675,30 @@ export namespace compute_alpha { */ zone?: string; } + export interface Params$Resource$Instances$Geteffectivefirewalls 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; + /** + * The name of the network interface to get the effective firewalls. + */ + networkInterface?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } export interface Params$Resource$Instances$Getguestattributes extends StandardParameters { /** @@ -46432,6 +47494,88 @@ export namespace compute_alpha { } + /** + * compute.networks.getEffectiveFirewalls + * @desc Returns the effective firewalls on a given network. + * @alias compute.networks.getEffectiveFirewalls + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.network Name of the network for this request. + * @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 + */ + getEffectiveFirewalls( + params?: Params$Resource$Networks$Geteffectivefirewalls, + options?: MethodOptions): + GaxiosPromise; + getEffectiveFirewalls( + params: Params$Resource$Networks$Geteffectivefirewalls, + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; + getEffectiveFirewalls( + params: Params$Resource$Networks$Geteffectivefirewalls, + callback: + BodyResponseCallback): + void; + getEffectiveFirewalls( + callback: + BodyResponseCallback): + void; + getEffectiveFirewalls( + paramsOrCallback?: Params$Resource$Networks$Geteffectivefirewalls| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Networks$Geteffectivefirewalls; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$Geteffectivefirewalls; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/global/networks/{network}/getEffectiveFirewalls') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], + context: this.context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + /** * compute.networks.insert * @desc Creates a network in the specified project using the data included @@ -47251,6 +48395,22 @@ export namespace compute_alpha { */ project?: string; } + export interface Params$Resource$Networks$Geteffectivefirewalls extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the network for this request. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + } export interface Params$Resource$Networks$Insert extends StandardParameters { /** * Auth client or API Key for the request diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index cdab5037d5e..b01e25ab021 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -852,6 +852,12 @@ export namespace compute_beta { * 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 @@ -877,6 +883,19 @@ export namespace compute_beta { * 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 @@ -1795,7 +1814,7 @@ export namespace compute_beta { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ @@ -3096,7 +3115,7 @@ export namespace compute_beta { export interface Schema$FixedOrPercent { /** * [Output Only] Absolute value of VM instances calculated based on the - * specific mode. - If the value is fixed, then the caculated value is + * specific mode. - If the value is fixed, then the calculated value is * equal to the fixed value. - If the value is a percent, then the * calculated value is percent/100 * targetSize. For example, the calculated * value of a 80% of a managed instance group with 150 instances would be @@ -3592,9 +3611,10 @@ export namespace compute_beta { */ timeoutSec?: number; /** - * Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If - * not specified, the default is TCP. Exactly one of the protocol-specific - * health check field must be specified, which must match type field. + * Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or + * HTTP2. If not specified, the default is TCP. Exactly one of the + * protocol-specific health check field must be specified, which must match + * type field. */ type?: string; /** @@ -4714,8 +4734,12 @@ export namespace compute_beta { */ namedPorts?: Schema$NamedPort[]; /** - * [Output Only] The list of instance actions and the number of instances in - * this managed instance group that are pending for each of those actions. + * [Deprecated] This field is deprecated and will be removed. Prefer using + * the status field instead. Please contact + * cloud-updater-feedback@google.com to leave feedback if your workload + * relies on this field. [Output Only] The list of instance actions and the + * number of instances in this managed instance group that are pending for + * each of those actions. */ pendingActions?: Schema$InstanceGroupManagerPendingActionsSummary; /** @@ -4758,12 +4782,12 @@ export namespace compute_beta { updatePolicy?: Schema$InstanceGroupManagerUpdatePolicy; /** * Specifies the instance templates used by this managed instance group to - * create instances. Each version is defined by an instanceTemplate. Every - * template can appear at most once per instance group. This field overrides - * the top-level instanceTemplate field. Read more about the relationships - * between these fields. Exactly one version must leave the targetSize field - * unset. That version will be applied to all remaining instances. For more - * information, read about canary updates. + * create instances. Each version is defined by an instanceTemplate and a + * name. Every version can appear at most once per instance group. This + * field overrides the top-level instanceTemplate field. Read more about the + * relationships between these fields. Exactly one version must leave the + * targetSize field unset. That version will be applied to all remaining + * instances. For more information, read about canary updates. */ versions?: Schema$InstanceGroupManagerVersion[]; /** @@ -4923,23 +4947,35 @@ export namespace compute_beta { } export interface Schema$InstanceGroupManagerPendingActionsSummary { /** - * [Output Only] The number of instances in the managed instance group that - * are pending to be created. + * [Deprecated] This field is deprecated and will be removed. Prefer using + * the status field instead. Please contact + * cloud-updater-feedback@google.com to leave feedback if your workload + * relies on this field. [Output Only] The number of instances in the + * managed instance group that are pending to be created. */ creating?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are pending to be deleted. + * [Deprecated] This field is deprecated and will be removed. Prefer using + * the status field instead. Please contact + * cloud-updater-feedback@google.com to leave feedback if your workload + * relies on this field. [Output Only] The number of instances in the + * managed instance group that are pending to be deleted. */ deleting?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are pending to be recreated. + * [Deprecated] This field is deprecated and will be removed. Prefer using + * the status field instead. Please contact + * cloud-updater-feedback@google.com to leave feedback if your workload + * relies on this field. [Output Only] The number of instances in the + * managed instance group that are pending to be recreated. */ recreating?: number; /** - * [Output Only] The number of instances in the managed instance group that - * are pending to be restarted. + * [Deprecated] This field is deprecated and will be removed. Prefer using + * the status field instead. Please contact + * cloud-updater-feedback@google.com to leave feedback if your workload + * relies on this field. [Output Only] The number of instances in the + * managed instance group that are pending to be restarted. */ restarting?: number; } @@ -5098,6 +5134,7 @@ export namespace compute_beta { isReached?: boolean; } export interface Schema$InstanceGroupManagerUpdatePolicy { + instanceRedistributionType?: string; /** * The maximum number of instances that can be created above the specified * targetSize during the update process. By default, a fixed value of 1 is @@ -5140,6 +5177,12 @@ export namespace compute_beta { type?: string; } export interface Schema$InstanceGroupManagerVersion { + /** + * The URL of the instance template that is specified for this managed + * instance group. The group uses this template to create new instances in + * the managed instance group until the `targetSize` for this version is + * reached. + */ instanceTemplate?: string; /** * Name of the version. Unique among all versions in the scope of this @@ -7424,8 +7467,10 @@ export namespace compute_beta { networkPeering?: Schema$NetworkPeering; } /** - * A NodeGroup resource. (== resource_for beta.nodeGroups ==) (== resource_for - * v1.nodeGroups ==) + * 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 ==) */ export interface Schema$NodeGroup { /** @@ -7636,7 +7681,9 @@ export namespace compute_beta { nodeTemplate?: string; } /** - * A Node Template resource. + * 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 ==) */ export interface Schema$NodeTemplate { /** @@ -9147,6 +9194,10 @@ export namespace compute_beta { * 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. @@ -9431,6 +9482,12 @@ export namespace compute_beta { * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ */ nextHopInstance?: string; + /** + * [Output Only] The URL to an InterconnectAttachment which is the next hop + * for the route. This field will only be populated for the dynamic routes + * generated by Cloud Router with a linked interconnectAttachment. + */ + nextHopInterconnectAttachment?: string; /** * The network IP address of an instance that should handle matching * packets. Only IPv4 is supported. @@ -13169,7 +13226,7 @@ export namespace compute_beta { } /** * A Zone resource. (== resource_for beta.zones ==) (== resource_for v1.zones - * ==) + * ==) Next ID: 17 */ export interface Schema$Zone { /** diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index e4cfaf1a525..75abb82c19e 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -1607,7 +1607,7 @@ export namespace compute_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ @@ -2675,7 +2675,7 @@ export namespace compute_v1 { export interface Schema$FixedOrPercent { /** * [Output Only] Absolute value of VM instances calculated based on the - * specific mode. - If the value is fixed, then the caculated value is + * specific mode. - If the value is fixed, then the calculated value is * equal to the fixed value. - If the value is a percent, then the * calculated value is percent/100 * targetSize. For example, the calculated * value of a 80% of a managed instance group with 150 instances would be @@ -3083,9 +3083,10 @@ export namespace compute_v1 { */ timeoutSec?: number; /** - * Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If - * not specified, the default is TCP. Exactly one of the protocol-specific - * health check field must be specified, which must match type field. + * Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or + * HTTP2. If not specified, the default is TCP. Exactly one of the + * protocol-specific health check field must be specified, which must match + * type field. */ type?: string; /** @@ -4220,12 +4221,12 @@ export namespace compute_v1 { updatePolicy?: Schema$InstanceGroupManagerUpdatePolicy; /** * Specifies the instance templates used by this managed instance group to - * create instances. Each version is defined by an instanceTemplate. Every - * template can appear at most once per instance group. This field overrides - * the top-level instanceTemplate field. Read more about the relationships - * between these fields. Exactly one version must leave the targetSize field - * unset. That version will be applied to all remaining instances. For more - * information, read about canary updates. + * create instances. Each version is defined by an instanceTemplate and a + * name. Every version can appear at most once per instance group. This + * field overrides the top-level instanceTemplate field. Read more about the + * relationships between these fields. Exactly one version must leave the + * targetSize field unset. That version will be applied to all remaining + * instances. For more information, read about canary updates. */ versions?: Schema$InstanceGroupManagerVersion[]; /** @@ -4501,6 +4502,12 @@ export namespace compute_v1 { type?: string; } export interface Schema$InstanceGroupManagerVersion { + /** + * The URL of the instance template that is specified for this managed + * instance group. The group uses this template to create new instances in + * the managed instance group until the `targetSize` for this version is + * reached. + */ instanceTemplate?: string; /** * Name of the version. Unique among all versions in the scope of this @@ -6687,8 +6694,10 @@ export namespace compute_v1 { name?: string; } /** - * A NodeGroup resource. (== resource_for beta.nodeGroups ==) (== resource_for - * v1.nodeGroups ==) + * 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 ==) */ export interface Schema$NodeGroup { /** @@ -6895,7 +6904,9 @@ export namespace compute_v1 { nodeTemplate?: string; } /** - * A Node Template resource. + * 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 ==) */ export interface Schema$NodeTemplate { /** @@ -11371,7 +11382,7 @@ export namespace compute_v1 { } /** * A Zone resource. (== resource_for beta.zones ==) (== resource_for v1.zones - * ==) + * ==) Next ID: 17 */ export interface Schema$Zone { /** diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index d3bbb4001eb..c34c642bff9 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -249,12 +249,18 @@ export namespace container_v1 { currentNodeCount?: number; /** * [Output only] Deprecated, use - * [NodePool.version](/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePool) + * [NodePools.version](/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools) * instead. The current version of the node software components. If they are * currently at multiple versions because they're in the process of * being upgraded, this reflects the minimum version of all nodes. */ currentNodeVersion?: string; + /** + * The default constraint on the maximum number of pods that can be run + * simultaneously on a node in the node pool of this cluster. Only honored + * if cluster created with IP Alias support. + */ + defaultMaxPodsConstraint?: Schema$MaxPodsConstraint; /** * An optional description of this cluster. */ @@ -666,31 +672,31 @@ export namespace container_v1 { */ export interface Schema$GetOpenIDConfigResponse { /** - * NOLINT + * Supported claims. */ claims_supported?: string[]; /** - * NOLINT + * Supported grant types. */ grant_types?: string[]; /** - * NOLINT + * supported ID Token signing Algorithms. */ id_token_signing_alg_values_supported?: string[]; /** - * NOLINT + * OIDC Issuer. */ issuer?: string; /** - * NOLINT + * JSON Web Key uri. */ jwks_uri?: string; /** - * NOLINT + * Supported response types. */ response_types_supported?: string[]; /** - * NOLINT + * Supported subject types. */ subject_types_supported?: string[]; } @@ -820,39 +826,39 @@ export namespace container_v1 { */ export interface Schema$Jwk { /** - * NOLINT + * Algorithm. */ alg?: string; /** - * NOLINT + * Used for ECDSA keys. */ crv?: string; /** - * NOLINT + * Used for RSA keys. */ e?: string; /** - * NOLINT + * Key ID. */ kid?: string; /** - * NOLINT + * Key Type. */ kty?: string; /** - * Fields for RSA keys. NOLINT + * Used for RSA keys. */ n?: string; /** - * NOLINT + * Permitted uses for the public keys. */ use?: string; /** - * Fields for ECDSA keys. NOLINT + * Used for ECDSA keys. */ x?: string; /** - * NOLINT + * Used for ECDSA keys. */ y?: string; } @@ -916,6 +922,23 @@ export namespace container_v1 { */ operations?: Schema$Operation[]; } + /** + * ListUsableSubnetworksResponse is the response of + * ListUsableSubnetworksRequest. + */ + export interface Schema$ListUsableSubnetworksResponse { + /** + * This token allows you to get the next page of results for list requests. + * If the number of results is larger than `page_size`, use the + * `next_page_token` as a value for the query parameter `page_token` in the + * next request. The value will become empty when there are no more pages. + */ + nextPageToken?: string; + /** + * A list of usable subnetworks in the specified network project. + */ + subnetworks?: Schema$UsableSubnetwork[]; + } /** * MaintenancePolicy defines the maintenance policy to be used for the * cluster. @@ -994,6 +1017,15 @@ export namespace container_v1 { */ enabled?: boolean; } + /** + * Constraints applied to pods. + */ + export interface Schema$MaxPodsConstraint { + /** + * Constraint enforced on the max num of pods per node. + */ + maxPodsPerNode?: string; + } /** * NetworkConfig reports the relative names of network & subnetwork. */ @@ -1218,6 +1250,11 @@ export namespace container_v1 { * NodeManagement configuration for this NodePool. */ management?: Schema$NodeManagement; + /** + * The constraint on the maximum number of pods that can be run + * simultaneously on a node in the node pool. + */ + maxPodsConstraint?: Schema$MaxPodsConstraint; /** * The name of the node pool. */ @@ -2023,20 +2060,204 @@ export namespace container_v1 { */ zone?: string; } + /** + * UsableSubnetwork resource returns the subnetwork name, its associated + * network and the primary CIDR range. + */ + export interface Schema$UsableSubnetwork { + /** + * The range of internal addresses that are owned by this subnetwork. + */ + ipCidrRange?: string; + /** + * Network Name. Example: projects/my-project/global/networks/my-network + */ + network?: string; + /** + * Secondary IP ranges. + */ + secondaryIpRanges?: Schema$UsableSubnetworkSecondaryRange[]; + /** + * A human readable status message representing the reasons for cases where + * the caller cannot use the secondary ranges under the subnet. For example + * if the secondary_ip_ranges is empty due to a permission issue, an + * insufficient permission message will be given by status_message. + */ + statusMessage?: string; + /** + * Subnetwork Name. Example: + * projects/my-project/regions/us-central1/subnetworks/my-subnet + */ + subnetwork?: string; + } + /** + * Secondary IP range of a usable subnetwork. + */ + export interface Schema$UsableSubnetworkSecondaryRange { + /** + * The range of IP addresses belonging to this subnetwork secondary range. + */ + ipCidrRange?: string; + /** + * The name associated with this subnetwork secondary range, used when + * adding an alias IP range to a VM instance. + */ + rangeName?: string; + /** + * This field is to determine the status of the secondary range + * programmably. + */ + status?: string; + } export class Resource$Projects { context: APIRequestContext; + aggregated: Resource$Projects$Aggregated; locations: Resource$Projects$Locations; zones: Resource$Projects$Zones; constructor(context: APIRequestContext) { this.context = context; + this.aggregated = new Resource$Projects$Aggregated(this.context); this.locations = new Resource$Projects$Locations(this.context); this.zones = new Resource$Projects$Zones(this.context); } } + export class Resource$Projects$Aggregated { + context: APIRequestContext; + usableSubnetworks: Resource$Projects$Aggregated$Usablesubnetworks; + constructor(context: APIRequestContext) { + this.context = context; + this.usableSubnetworks = + new Resource$Projects$Aggregated$Usablesubnetworks(this.context); + } + } + + + export class Resource$Projects$Aggregated$Usablesubnetworks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + + /** + * container.projects.aggregated.usableSubnetworks.list + * @desc Lists subnetworks that are usable for creating clusters in a + * project. + * @alias container.projects.aggregated.usableSubnetworks.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter Filtering currently only supports equality on the networkProjectId and must be in the form: "networkProjectId=[PROJECTID]", where `networkProjectId` is the project which owns the listed subnetworks. This defaults to the parent project ID. + * @param {integer=} params.pageSize The max number of results per page that should be returned. If the number of available results is larger than `page_size`, a `next_page_token` is returned which can be used to get the next page of results in subsequent requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.pageToken Specifies a page token to use. Set this to the nextPageToken returned by previous list requests to get the next page of results. + * @param {string} params.parent The parent project where subnetworks are usable. Specified in the format 'projects/x'. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Aggregated$Usablesubnetworks$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Projects$Aggregated$Usablesubnetworks$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Projects$Aggregated$Usablesubnetworks$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: + Params$Resource$Projects$Aggregated$Usablesubnetworks$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Aggregated$Usablesubnetworks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Aggregated$Usablesubnetworks$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://container.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/aggregated/usableSubnetworks') + .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$Aggregated$Usablesubnetworks$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Filtering currently only supports equality on the networkProjectId and + * must be in the form: "networkProjectId=[PROJECTID]", where + * `networkProjectId` is the project which owns the listed subnetworks. This + * defaults to the parent project ID. + */ + filter?: string; + /** + * The max number of results per page that should be returned. If the number + * of available results is larger than `page_size`, a `next_page_token` is + * returned which can be used to get the next page of results in subsequent + * requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + pageSize?: number; + /** + * Specifies a page token to use. Set this to the nextPageToken returned by + * previous list requests to get the next page of results. + */ + pageToken?: string; + /** + * The parent project where subnetworks are usable. Specified in the format + * 'projects/x'. + */ + parent?: string; + } + + + export class Resource$Projects$Locations { context: APIRequestContext; clusters: Resource$Projects$Locations$Clusters; @@ -2051,7 +2272,8 @@ export namespace container_v1 { /** * container.projects.locations.getServerConfig - * @desc Returns configuration info about the Kubernetes Engine service. + * @desc Returns configuration info about the Google Kubernetes Engine + * service. * @alias container.projects.locations.getServerConfig * @memberOf! () * @@ -2233,11 +2455,11 @@ export namespace container_v1 { * 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 cluster creates routes + * 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 is being used by - * the cluster. + * project's global metadata indicating which CIDR range the cluster is + * using. * @alias container.projects.locations.clusters.create * @memberOf! () * @@ -2308,8 +2530,8 @@ export namespace container_v1 { * @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 (e.g. load balancer resources) will not be - * deleted if they weren't present at the initial create time. + * 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. * @alias container.projects.locations.clusters.delete * @memberOf! () * @@ -2442,9 +2664,9 @@ export namespace container_v1 { /** * container.projects.locations.clusters.getJwks - * @desc GetJSONWebKeys 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. + * @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! () * @@ -2935,9 +3157,9 @@ export namespace container_v1 { /** * container.projects.locations.clusters.setMasterAuth - * @desc Used to set master auth materials. Currently supports :- Changing - * the admin password for a specific cluster. This can be either via - * password generation or explicitly set the password. + * @desc Sets master auth materials. Currently supports changing the admin + * password or a specific cluster, either via password generation or + * explicitly setting the password. * @alias container.projects.locations.clusters.setMasterAuth * @memberOf! () * @@ -3077,7 +3299,7 @@ export namespace container_v1 { /** * container.projects.locations.clusters.setNetworkPolicy - * @desc Enables/Disables Network Policy for a cluster. + * @desc Enables or disables Network Policy for a cluster. * @alias container.projects.locations.clusters.setNetworkPolicy * @memberOf! () * @@ -3217,7 +3439,7 @@ export namespace container_v1 { /** * container.projects.locations.clusters.startIpRotation - * @desc Start master IP rotation. + * @desc Starts master IP rotation. * @alias container.projects.locations.clusters.startIpRotation * @memberOf! () * @@ -3926,7 +4148,7 @@ export namespace container_v1 { /** * container.projects.locations.clusters.nodePools.get - * @desc Retrieves the node pool requested. + * @desc Retrieves the requested node pool. * @alias container.projects.locations.clusters.nodePools.get * @memberOf! () * @@ -4066,8 +4288,8 @@ export namespace container_v1 { /** * container.projects.locations.clusters.nodePools.rollback - * @desc Roll back the previously Aborted or Failed NodePool upgrade. This - * will be an no-op if the last upgrade successfully completed. + * @desc Rolls back a previously Aborted or Failed NodePool upgrade. This + * makes no changes if the last upgrade successfully completed. * @alias container.projects.locations.clusters.nodePools.rollback * @memberOf! () * @@ -4137,7 +4359,7 @@ export namespace container_v1 { /** * container.projects.locations.clusters.nodePools.setAutoscaling - * @desc Sets the autoscaling settings for a specific node pool. + * @desc Sets the autoscaling settings for the specified node pool. * @alias container.projects.locations.clusters.nodePools.setAutoscaling * @memberOf! () * @@ -4353,7 +4575,7 @@ export namespace container_v1 { /** * container.projects.locations.clusters.nodePools.update - * @desc Updates the version and/or image type for a specific node pool. + * @desc Updates the version and/or image type for the specified node pool. * @alias container.projects.locations.clusters.nodePools.update * @memberOf! () * @@ -4646,10 +4868,11 @@ export namespace container_v1 { /** * container.projects.locations.clusters.well-known.getOpenid-configuration - * @desc GetOpenIDConfig gets the OIDC discovery document for the cluster. - * See the OpenID Connect Discovery 1.0 specification for details. - * https://openid.net/specs/openid-connect-discovery-1_0.html This API is - * not yet intended for general use, and is not available for all clusters. + * @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. * @alias * container.projects.locations.clusters.well-known.getOpenid-configuration * @memberOf! () @@ -5038,7 +5261,8 @@ export namespace container_v1 { /** * container.projects.zones.getServerconfig - * @desc Returns configuration info about the Kubernetes Engine service. + * @desc Returns configuration info about the Google Kubernetes Engine + * service. * @example * * // BEFORE RUNNING: * // --------------- @@ -5480,11 +5704,11 @@ export namespace container_v1 { * 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 cluster creates routes + * 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 is being used by - * the cluster. + * project's global metadata indicating which CIDR range the cluster is + * using. * @example * * // BEFORE RUNNING: * // --------------- @@ -5617,8 +5841,8 @@ export namespace container_v1 { * @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 (e.g. load balancer resources) will not be - * deleted if they weren't present at the initial create time. + * 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: * // --------------- @@ -6962,9 +7186,9 @@ export namespace container_v1 { /** * container.projects.zones.clusters.setMasterAuth - * @desc Used to set master auth materials. Currently supports :- Changing - * the admin password for a specific cluster. This can be either via - * password generation or explicitly set the password. + * @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: * // --------------- @@ -7101,7 +7325,7 @@ export namespace container_v1 { /** * container.projects.zones.clusters.setNetworkPolicy - * @desc Enables/Disables Network Policy for a cluster. + * @desc Enables or disables Network Policy for a cluster. * @example * * // BEFORE RUNNING: * // --------------- @@ -7239,7 +7463,7 @@ export namespace container_v1 { /** * container.projects.zones.clusters.startIpRotation - * @desc Start master IP rotation. + * @desc Starts master IP rotation. * @example * * // BEFORE RUNNING: * // --------------- @@ -8022,7 +8246,7 @@ export namespace container_v1 { /** * container.projects.zones.clusters.nodePools.autoscaling - * @desc Sets the autoscaling settings for a specific node pool. + * @desc Sets the autoscaling settings for the specified node pool. * @example * * // BEFORE RUNNING: * // --------------- @@ -8440,7 +8664,7 @@ export namespace container_v1 { /** * container.projects.zones.clusters.nodePools.get - * @desc Retrieves the node pool requested. + * @desc Retrieves the requested node pool. * @example * * // BEFORE RUNNING: * // --------------- @@ -8708,8 +8932,8 @@ export namespace container_v1 { /** * container.projects.zones.clusters.nodePools.rollback - * @desc Roll back the previously Aborted or Failed NodePool upgrade. This - * will be an no-op if the last upgrade successfully completed. + * @desc Rolls back a previously Aborted or Failed NodePool upgrade. This + * makes no changes if the last upgrade successfully completed. * @example * * // BEFORE RUNNING: * // --------------- @@ -9136,7 +9360,7 @@ export namespace container_v1 { /** * container.projects.zones.clusters.nodePools.update - * @desc Updates the version and/or image type for a specific node pool. + * @desc Updates the version and/or image type for the specified node pool. * @example * * // BEFORE RUNNING: * // --------------- diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 059ef159c73..73128d5c4fc 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -315,7 +315,7 @@ export namespace container_v1beta1 { currentNodeCount?: number; /** * [Output only] Deprecated, use - * [NodePool.version](/kubernetes-engine/docs/reference/rest/v1beta1/projects.zones.clusters.nodePool) + * [NodePool.version](/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) * instead. The current version of the node software components. If they are * currently at multiple versions because they're in the process of * being upgraded, this reflects the minimum version of all nodes. @@ -836,31 +836,31 @@ export namespace container_v1beta1 { */ export interface Schema$GetOpenIDConfigResponse { /** - * NOLINT + * Supported claims. */ claims_supported?: string[]; /** - * NOLINT + * Supported grant types. */ grant_types?: string[]; /** - * NOLINT + * supported ID Token signing Algorithms. */ id_token_signing_alg_values_supported?: string[]; /** - * NOLINT + * OIDC Issuer. */ issuer?: string; /** - * NOLINT + * JSON Web Key uri. */ jwks_uri?: string; /** - * NOLINT + * Supported response types. */ response_types_supported?: string[]; /** - * NOLINT + * Supported subject types. */ subject_types_supported?: string[]; } @@ -1026,39 +1026,39 @@ export namespace container_v1beta1 { */ export interface Schema$Jwk { /** - * NOLINT + * Algorithm. */ alg?: string; /** - * NOLINT + * Used for ECDSA keys. */ crv?: string; /** - * NOLINT + * Used for RSA keys. */ e?: string; /** - * NOLINT + * Key ID. */ kid?: string; /** - * NOLINT + * Key Type. */ kty?: string; /** - * Fields for RSA keys. NOLINT + * Used for RSA keys. */ n?: string; /** - * NOLINT + * Permitted uses for the public keys. */ use?: string; /** - * Fields for ECDSA keys. NOLINT + * Used for ECDSA keys. */ x?: string; /** - * NOLINT + * Used for ECDSA keys. */ y?: string; } @@ -1431,6 +1431,10 @@ export namespace container_v1beta1 { * inforamtion about preemptible VM instances. */ preemptible?: boolean; + /** + * Sandbox configuration for this node. + */ + sandboxConfig?: Schema$SandboxConfig; /** * The Google Cloud Platform Service Account to be used by the node VMs. If * no Service Account is specified, the "default" service account @@ -1789,6 +1793,15 @@ export namespace container_v1beta1 { */ zone?: string; } + /** + * SandboxConfig contains configurations of the sandbox to use for the node. + */ + export interface Schema$SandboxConfig { + /** + * Type of the sandbox to use for the node (e.g. 'gvisor') + */ + sandboxType?: string; + } /** * Kubernetes Engine service configuration. */ @@ -2464,8 +2477,8 @@ export namespace container_v1beta1 { */ export interface Schema$WorkloadMetadataConfig { /** - * NodeMetadata is the configuration for how to expose the node metadata to - * the workload running on the node. + * NodeMetadata is the configuration for how to expose metadata to the + * workloads running on the node. */ nodeMetadata?: string; } @@ -2505,7 +2518,7 @@ export namespace container_v1beta1 { /** * container.projects.aggregated.usableSubnetworks.list - * @desc Lists subnetworks that are usable for creating clusters in a + * @desc Lists subnetworks that can be used for creating clusters in a * project. * @alias container.projects.aggregated.usableSubnetworks.list * @memberOf! () @@ -2632,7 +2645,8 @@ export namespace container_v1beta1 { /** * container.projects.locations.getServerConfig - * @desc Returns configuration info about the Kubernetes Engine service. + * @desc Returns configuration info about the Google Kubernetes Engine + * service. * @alias container.projects.locations.getServerConfig * @memberOf! () * @@ -2701,7 +2715,7 @@ export namespace container_v1beta1 { /** * container.projects.locations.list - * @desc Used to fetch locations that offer GKE. + * @desc Fetches locations that offer Google Kubernetes Engine. * @alias container.projects.locations.list * @memberOf! () * @@ -2895,11 +2909,11 @@ export namespace container_v1beta1 { * 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 cluster creates routes + * 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 is being used by - * the cluster. + * project's global metadata indicating which CIDR range the cluster is + * using. * @alias container.projects.locations.clusters.create * @memberOf! () * @@ -2970,8 +2984,8 @@ export namespace container_v1beta1 { * @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 (e.g. load balancer resources) will not be - * deleted if they weren't present at the initial create time. + * 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. * @alias container.projects.locations.clusters.delete * @memberOf! () * @@ -3104,9 +3118,9 @@ export namespace container_v1beta1 { /** * container.projects.locations.clusters.getJwks - * @desc GetJSONWebKeys 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. + * @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! () * @@ -3597,10 +3611,9 @@ export namespace container_v1beta1 { /** * container.projects.locations.clusters.setMasterAuth - * @desc Used to set master auth materials. Currently supports :- Changing - * the admin password for a specific cluster. This can be either via - * password generation or explicitly set. Modify basic_auth.csv and reset - * the K8S API server. + * @desc Sets master auth materials. Currently supports changing the admin + * password or a specific cluster, either via password generation or + * explicitly setting the password. * @alias container.projects.locations.clusters.setMasterAuth * @memberOf! () * @@ -3740,7 +3753,7 @@ export namespace container_v1beta1 { /** * container.projects.locations.clusters.setNetworkPolicy - * @desc Enables/Disables Network Policy for a cluster. + * @desc Enables or disables Network Policy for a cluster. * @alias container.projects.locations.clusters.setNetworkPolicy * @memberOf! () * @@ -3880,7 +3893,7 @@ export namespace container_v1beta1 { /** * container.projects.locations.clusters.startIpRotation - * @desc Start master IP rotation. + * @desc Starts master IP rotation. * @alias container.projects.locations.clusters.startIpRotation * @memberOf! () * @@ -4589,7 +4602,7 @@ export namespace container_v1beta1 { /** * container.projects.locations.clusters.nodePools.get - * @desc Retrieves the node pool requested. + * @desc Retrieves the requested node pool. * @alias container.projects.locations.clusters.nodePools.get * @memberOf! () * @@ -4729,8 +4742,8 @@ export namespace container_v1beta1 { /** * container.projects.locations.clusters.nodePools.rollback - * @desc Roll back the previously Aborted or Failed NodePool upgrade. This - * will be an no-op if the last upgrade successfully completed. + * @desc Rolls back a previously Aborted or Failed NodePool upgrade. This + * makes no changes if the last upgrade successfully completed. * @alias container.projects.locations.clusters.nodePools.rollback * @memberOf! () * @@ -5309,10 +5322,11 @@ export namespace container_v1beta1 { /** * container.projects.locations.clusters.well-known.getOpenid-configuration - * @desc GetOpenIDConfig gets the OIDC discovery document for the cluster. - * See the OpenID Connect Discovery 1.0 specification for details. - * https://openid.net/specs/openid-connect-discovery-1_0.html This API is - * not yet intended for general use, and is not available for all clusters. + * @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. * @alias * container.projects.locations.clusters.well-known.getOpenid-configuration * @memberOf! () @@ -5543,7 +5557,8 @@ export namespace container_v1beta1 { /** * container.projects.locations.operations.list - * @desc Lists all operations in a project in a specific zone or all zones. + * @desc Lists all operations in a project in the specified zone or all + * zones. * @alias container.projects.locations.operations.list * @memberOf! () * @@ -5702,7 +5717,8 @@ export namespace container_v1beta1 { /** * container.projects.zones.getServerconfig - * @desc Returns configuration info about the Kubernetes Engine service. + * @desc Returns configuration info about the Google Kubernetes Engine + * service. * @alias container.projects.zones.getServerconfig * @memberOf! () * @@ -5958,11 +5974,11 @@ export namespace container_v1beta1 { * 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 cluster creates routes + * 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 is being used by - * the cluster. + * project's global metadata indicating which CIDR range the cluster is + * using. * @alias container.projects.zones.clusters.create * @memberOf! () * @@ -6035,8 +6051,8 @@ export namespace container_v1beta1 { * @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 (e.g. load balancer resources) will not be - * deleted if they weren't present at the initial create time. + * 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. * @alias container.projects.zones.clusters.delete * @memberOf! () * @@ -6755,10 +6771,9 @@ export namespace container_v1beta1 { /** * container.projects.zones.clusters.setMasterAuth - * @desc Used to set master auth materials. Currently supports :- Changing - * the admin password for a specific cluster. This can be either via - * password generation or explicitly set. Modify basic_auth.csv and reset - * the K8S API server. + * @desc Sets master auth materials. Currently supports changing the admin + * password or a specific cluster, either via password generation or + * explicitly setting the password. * @alias container.projects.zones.clusters.setMasterAuth * @memberOf! () * @@ -6831,7 +6846,7 @@ export namespace container_v1beta1 { /** * container.projects.zones.clusters.setNetworkPolicy - * @desc Enables/Disables Network Policy for a cluster. + * @desc Enables or disables Network Policy for a cluster. * @alias container.projects.zones.clusters.setNetworkPolicy * @memberOf! () * @@ -6904,7 +6919,7 @@ export namespace container_v1beta1 { /** * container.projects.zones.clusters.startIpRotation - * @desc Start master IP rotation. + * @desc Starts master IP rotation. * @alias container.projects.zones.clusters.startIpRotation * @memberOf! () * @@ -7778,7 +7793,7 @@ export namespace container_v1beta1 { /** * container.projects.zones.clusters.nodePools.get - * @desc Retrieves the node pool requested. + * @desc Retrieves the requested node pool. * @alias container.projects.zones.clusters.nodePools.get * @memberOf! () * @@ -7921,8 +7936,8 @@ export namespace container_v1beta1 { /** * container.projects.zones.clusters.nodePools.rollback - * @desc Roll back the previously Aborted or Failed NodePool upgrade. This - * will be an no-op if the last upgrade successfully completed. + * @desc Rolls back a previously Aborted or Failed NodePool upgrade. This + * makes no changes if the last upgrade successfully completed. * @alias container.projects.zones.clusters.nodePools.rollback * @memberOf! () * @@ -8678,7 +8693,8 @@ export namespace container_v1beta1 { /** * container.projects.zones.operations.list - * @desc Lists all operations in a project in a specific zone or all zones. + * @desc Lists all operations in a project in the specified zone or all + * zones. * @alias container.projects.zones.operations.list * @memberOf! () * diff --git a/src/apis/dns/v1.ts b/src/apis/dns/v1.ts index 7963310d06f..fb02c1d3c20 100644 --- a/src/apis/dns/v1.ts +++ b/src/apis/dns/v1.ts @@ -100,61 +100,201 @@ export namespace dns_v1 { } } + /** + * A Change represents a set of ResourceRecordSet additions and deletions + * applied atomically to a ManagedZone. ResourceRecordSets within a + * ManagedZone are modified by creating a new Change element in the Changes + * collection. In turn the Changes collection also records the past + * modifications to the ResourceRecordSets in a ManagedZone. The current state + * of the ManagedZone is the sum effect of applying all Change elements in the + * Changes collection in sequence. + */ export interface Schema$Change { + /** + * Which ResourceRecordSets to add? + */ additions?: Schema$ResourceRecordSet[]; + /** + * Which ResourceRecordSets to remove? Must match existing data exactly. + */ deletions?: Schema$ResourceRecordSet[]; + /** + * Unique identifier for the resource; defined by the server (output only). + */ id?: string; + /** + * If the DNS queries for the zone will be served. + */ isServing?: boolean; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#change". */ kind?: string; + /** + * The time that this operation was started by the server (output only). + * This is in RFC3339 text format. + */ startTime?: string; + /** + * Status of the operation (output only). A status of "done" means + * that the request to update the authoritative servers has been sent, but + * the servers might not be updated yet. + */ status?: string; } + /** + * The response to a request to enumerate Changes to a ResourceRecordSets + * collection. + */ export interface Schema$ChangesListResponse { + /** + * The requested changes. + */ changes?: Schema$Change[]; header?: Schema$ResponseHeader; /** * Type of resource. */ kind?: string; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your pagination token. In + * this way you can retrieve the complete contents of even very large + * collections one page at a time. However, if the contents of the + * collection change between the first and last paginated list request, the + * set of all elements returned will be an inconsistent view of the + * collection. There is no way to retrieve a "snapshot" of + * collections larger than the maximum page size. + */ nextPageToken?: string; } + /** + * A DNSSEC key pair. + */ export interface Schema$DnsKey { + /** + * String mnemonic specifying the DNSSEC algorithm of this key. Immutable + * after creation time. + */ algorithm?: string; + /** + * The time that this resource was created in the control plane. This is in + * RFC3339 text format. Output only. + */ creationTime?: string; + /** + * A mutable string of at most 1024 characters associated with this resource + * for the user's convenience. Has no effect on the resource's + * function. + */ description?: string; + /** + * Cryptographic hashes of the DNSKEY resource record associated with this + * DnsKey. These digests are needed to construct a DS record that points at + * this DNS key. Output only. + */ digests?: Schema$DnsKeyDigest[]; + /** + * Unique identifier for the resource; defined by the server (output only). + */ id?: string; + /** + * Active keys will be used to sign subsequent changes to the ManagedZone. + * Inactive keys will still be present as DNSKEY Resource Records for the + * use of resolvers validating existing signatures. + */ isActive?: boolean; + /** + * Length of the key in bits. Specified at creation time then immutable. + */ keyLength?: number; + /** + * The key tag is a non-cryptographic hash of the a DNSKEY resource record + * associated with this DnsKey. The key tag can be used to identify a DNSKEY + * more quickly (but it is not a unique identifier). In particular, the key + * tag is used in a parent zone's DS record to point at the DNSKEY in + * this child ManagedZone. The key tag is a number in the range [0, 65535] + * and the algorithm to calculate it is specified in RFC4034 Appendix B. + * Output only. + */ keyTag?: number; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#dnsKey". */ kind?: string; + /** + * Base64 encoded public half of this key. Output only. + */ publicKey?: string; + /** + * One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type + * KEY_SIGNING have the Secure Entry Point flag set and, when active, will + * be used to sign only resource record sets of type DNSKEY. Otherwise, the + * Secure Entry Point flag will be cleared and this key will be used to sign + * only resource record sets of other types. Immutable after creation time. + */ type?: string; } export interface Schema$DnsKeyDigest { + /** + * The base-16 encoded bytes of this digest. Suitable for use in a DS + * resource record. + */ digest?: string; + /** + * Specifies the algorithm used to calculate this digest. + */ type?: string; } + /** + * The response to a request to enumerate DnsKeys in a ManagedZone. + */ export interface Schema$DnsKeysListResponse { + /** + * The requested resources. + */ dnsKeys?: Schema$DnsKey[]; header?: Schema$ResponseHeader; /** * Type of resource. */ kind?: string; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your pagination token. In + * this way you can retrieve the complete contents of even very large + * collections one page at a time. However, if the contents of the + * collection change between the first and last paginated list request, the + * set of all elements returned will be an inconsistent view of the + * collection. There is no way to retrieve a "snapshot" of + * collections larger than the maximum page size. + */ nextPageToken?: string; } + /** + * Parameters for DnsKey key generation. Used for generating initial keys for + * a new ManagedZone and as default when adding a new DnsKey. + */ export interface Schema$DnsKeySpec { + /** + * String mnemonic specifying the DNSSEC algorithm of this key. + */ algorithm?: string; + /** + * Length of the keys in bits. + */ keyLength?: number; + /** + * Specifies whether this is a key signing key (KSK) or a zone signing key + * (ZSK). Key signing keys have the Secure Entry Point flag set and, when + * active, will only be used to sign resource record sets of type DNSKEY. + * Zone signing keys do not have the Secure Entry Point flag set and will be + * used to sign all other types of resource record sets. + */ keyType?: string; /** * Identifies what kind of resource this is. Value: the fixed string @@ -162,32 +302,91 @@ export namespace dns_v1 { */ kind?: string; } + /** + * A zone is a subtree of the DNS namespace under one administrative + * responsibility. A ManagedZone is a resource that represents a DNS zone + * hosted by the Cloud DNS service. + */ export interface Schema$ManagedZone { + /** + * The time that this resource was created on the server. This is in RFC3339 + * text format. Output only. + */ creationTime?: string; + /** + * A mutable string of at most 1024 characters associated with this resource + * for the user's convenience. Has no effect on the managed zone's + * function. + */ description?: string; + /** + * The DNS name of this managed zone, for instance "example.com.". + */ dnsName?: string; + /** + * DNSSEC configuration. + */ dnssecConfig?: Schema$ManagedZoneDnsSecConfig; + /** + * Unique identifier for the resource; defined by the server (output only) + */ id?: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#managedZone". */ kind?: string; + /** + * User labels. + */ labels?: {[key: string]: string;}; + /** + * User assigned name for this resource. Must be unique within the project. + * The name must be 1-63 characters long, must begin with a letter, end with + * a letter or digit, and only contain lowercase letters, digits or dashes. + */ name?: string; + /** + * Delegate your managed_zone to these virtual name servers; defined by the + * server (output only) + */ nameServers?: string[]; + /** + * Optionally specifies the NameServerSet for this ManagedZone. A + * NameServerSet is a set of DNS name servers that all host the same + * ManagedZones. Most users will leave this field unset. + */ nameServerSet?: string; + /** + * For privately visible zones, the set of Virtual Private Cloud resources + * that the zone is visible from. + */ privateVisibilityConfig?: Schema$ManagedZonePrivateVisibilityConfig; + /** + * The zone's visibility: public zones are exposed to the Internet, + * while private zones are visible only to Virtual Private Cloud resources. + */ visibility?: string; } export interface Schema$ManagedZoneDnsSecConfig { + /** + * Specifies parameters that will be used for generating initial DnsKeys for + * this ManagedZone. Output only while state is not OFF. + */ defaultKeySpecs?: Schema$DnsKeySpec[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#managedZoneDnsSecConfig". */ kind?: string; + /** + * Specifies the mechanism used to provide authenticated denial-of-existence + * responses. Output only while state is not OFF. + */ nonExistence?: string; + /** + * Specifies whether DNSSEC is enabled, and what mode it is in. + */ state?: string; } export interface Schema$ManagedZoneOperationsListResponse { @@ -196,7 +395,21 @@ export namespace dns_v1 { * Type of resource. */ kind?: string; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your page token. In this + * way you can retrieve the complete contents of even very large collections + * one page at a time. However, if the contents of the collection change + * between the first and last paginated list request, the set of all + * elements returned will be an inconsistent view of the collection. There + * is no way to retrieve a consistent snapshot of a collection larger than + * the maximum page size. + */ nextPageToken?: string; + /** + * The operation resources. + */ operations?: Schema$Operation[]; } export interface Schema$ManagedZonePrivateVisibilityConfig { @@ -205,6 +418,9 @@ export namespace dns_v1 { * "dns#managedZonePrivateVisibilityConfig". */ kind?: string; + /** + * The list of VPC networks that can see this zone. + */ networks?: Schema$ManagedZonePrivateVisibilityConfigNetwork[]; } export interface Schema$ManagedZonePrivateVisibilityConfigNetwork { @@ -213,6 +429,11 @@ export namespace dns_v1 { * "dns#managedZonePrivateVisibilityConfigNetwork". */ kind?: string; + /** + * The fully qualified URL of the VPC network to bind to. This should be + * formatted like + * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + */ networkUrl?: string; } export interface Schema$ManagedZonesListResponse { @@ -221,68 +442,204 @@ export namespace dns_v1 { * Type of resource. */ kind?: string; + /** + * The managed zone resources. + */ managedZones?: Schema$ManagedZone[]; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your page token. In this + * way you can retrieve the complete contents of even very large collections + * one page at a time. However, if the contents of the collection change + * between the first and last paginated list request, the set of all + * elements returned will be an inconsistent view of the collection. There + * is no way to retrieve a consistent snapshot of a collection larger than + * the maximum page size. + */ nextPageToken?: string; } + /** + * An operation represents a successful mutation performed on a Cloud DNS + * resource. Operations provide: - An audit log of server resource mutations. + * - A way to recover/retry API calls in the case where the response is never + * received by the caller. Use the caller specified client_operation_id. + */ export interface Schema$Operation { + /** + * Only populated if the operation targeted a DnsKey (output only). + */ dnsKeyContext?: Schema$OperationDnsKeyContext; + /** + * Unique identifier for the resource. This is the client_operation_id if + * the client specified it when the mutation was initiated, otherwise, it is + * generated by the server. The name must be 1-63 characters long and match + * the regular expression [-a-z0-9]? (output only) + */ id?: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#operation". */ kind?: string; + /** + * The time that this operation was started by the server. This is in + * RFC3339 text format (output only). + */ startTime?: string; + /** + * Status of the operation. Can be one of the following: "PENDING" + * or "DONE" (output only). A status of "DONE" means + * that the request to update the authoritative servers has been sent, but + * the servers might not be updated yet. + */ status?: string; + /** + * Type of the operation. Operations include insert, update, and delete + * (output only). + */ type?: string; + /** + * User who requested the operation, for example: user@example.com. + * cloud-dns-system for operations automatically done by the system. (output + * only) + */ user?: string; + /** + * Only populated if the operation targeted a ManagedZone (output only). + */ zoneContext?: Schema$OperationManagedZoneContext; } export interface Schema$OperationDnsKeyContext { + /** + * The post-operation DnsKey resource. + */ newValue?: Schema$DnsKey; + /** + * The pre-operation DnsKey resource. + */ oldValue?: Schema$DnsKey; } export interface Schema$OperationManagedZoneContext { + /** + * The post-operation ManagedZone resource. + */ newValue?: Schema$ManagedZone; + /** + * The pre-operation ManagedZone resource. + */ oldValue?: Schema$ManagedZone; } + /** + * A project resource. The project is a top level container for resources + * including Cloud DNS ManagedZones. Projects can be created only in the APIs + * console. + */ export interface Schema$Project { + /** + * User assigned unique identifier for the resource (output only). + */ id?: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#project". */ kind?: string; + /** + * Unique numeric identifier for the resource; defined by the server (output + * only). + */ number?: string; + /** + * Quotas assigned to this project (output only). + */ quota?: Schema$Quota; } + /** + * Limits associated with a Project. + */ export interface Schema$Quota { + /** + * Maximum allowed number of DnsKeys per ManagedZone. + */ dnsKeysPerManagedZone?: number; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#quota". */ kind?: string; + /** + * Maximum allowed number of managed zones in the project. + */ managedZones?: number; + /** + * Maximum allowed number of managed zones which can be attached to a + * network. + */ managedZonesPerNetwork?: number; + /** + * Maximum allowed number of networks to which a privately scoped zone can + * be attached. + */ networksPerManagedZone?: number; + /** + * Maximum allowed number of ResourceRecords per ResourceRecordSet. + */ resourceRecordsPerRrset?: number; + /** + * Maximum allowed number of ResourceRecordSets to add per + * ChangesCreateRequest. + */ rrsetAdditionsPerChange?: number; + /** + * Maximum allowed number of ResourceRecordSets to delete per + * ChangesCreateRequest. + */ rrsetDeletionsPerChange?: number; + /** + * Maximum allowed number of ResourceRecordSets per zone in the project. + */ rrsetsPerManagedZone?: number; + /** + * Maximum allowed size for total rrdata in one ChangesCreateRequest in + * bytes. + */ totalRrdataSizePerChange?: number; + /** + * DNSSEC algorithm and key length types that can be used for DnsKeys. + */ whitelistedKeySpecs?: Schema$DnsKeySpec[]; } + /** + * A unit of data that will be returned by the DNS servers. + */ export interface Schema$ResourceRecordSet { /** * Identifies what kind of resource this is. Value: the fixed string * "dns#resourceRecordSet". */ kind?: string; + /** + * For example, www.example.com. + */ name?: string; + /** + * As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see + * examples. + */ rrdatas?: string[]; + /** + * As defined in RFC 4034 (section 3.2). + */ signatureRrdatas?: string[]; + /** + * Number of seconds that this ResourceRecordSet can be cached by resolvers. + */ ttl?: number; + /** + * The identifier of a supported record type. See the list of Supported DNS + * record types. + */ type?: string; } export interface Schema$ResourceRecordSetsListResponse { @@ -291,10 +648,32 @@ export namespace dns_v1 { * Type of resource. */ kind?: string; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your pagination token. In + * this way you can retrieve the complete contents of even very large + * collections one page at a time. However, if the contents of the + * collection change between the first and last paginated list request, the + * set of all elements returned will be an inconsistent view of the + * collection. There is no way to retrieve a consistent snapshot of a + * collection larger than the maximum page size. + */ nextPageToken?: string; + /** + * The resource record set resources. + */ rrsets?: Schema$ResourceRecordSet[]; } + /** + * Elements common to every response. + */ export interface Schema$ResponseHeader { + /** + * For mutating operation requests that completed successfully. This is the + * client_operation_id if the client specified it, otherwise it is generated + * by the server (output only). + */ operationId?: string; } @@ -308,6 +687,7 @@ export namespace dns_v1 { /** * dns.changes.create + * @desc Atomically update the ResourceRecordSet collection. * @example * * // BEFORE RUNNING: * // --------------- @@ -373,9 +753,9 @@ export namespace dns_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by this request. * @param {().Change} 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. @@ -437,6 +817,7 @@ export namespace dns_v1 { /** * dns.changes.get + * @desc Fetch the representation of an existing Change. * @example * * // BEFORE RUNNING: * // --------------- @@ -502,10 +883,10 @@ export namespace dns_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.changeId - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string} params.changeId The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by 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 @@ -563,6 +944,7 @@ export namespace dns_v1 { /** * dns.changes.list + * @desc Enumerate Changes to a ResourceRecordSet collection. * @example * * // BEFORE RUNNING: * // --------------- @@ -637,12 +1019,12 @@ export namespace dns_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.managedZone - * @param {integer=} params.maxResults - * @param {string=} params.pageToken - * @param {string} params.project - * @param {string=} params.sortBy - * @param {string=} params.sortOrder + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {string=} params.sortBy Sorting criterion. The only supported value is change sequence. + * @param {string=} params.sortOrder Sorting order direction: 'ascending' or 'descending'. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -709,15 +1091,18 @@ export namespace dns_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; @@ -733,19 +1118,23 @@ export namespace dns_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * The identifier of the requested change, from a previous + * ResourceRecordSetsChangeResponse. */ changeId?: string; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -756,27 +1145,30 @@ export namespace dns_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. */ maxResults?: number; /** - * + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. */ pageToken?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; /** - * + * Sorting criterion. The only supported value is change sequence. */ sortBy?: string; /** - * + * Sorting order direction: 'ascending' or 'descending'. */ sortOrder?: string; } @@ -791,15 +1183,16 @@ export namespace dns_v1 { /** * dns.dnsKeys.get + * @desc Fetch the representation of an existing DnsKey. * @alias dns.dnsKeys.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string=} params.digestType - * @param {string} params.dnsKeyId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string=} params.digestType An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed. + * @param {string} params.dnsKeyId The identifier of the requested DnsKey. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by 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 @@ -857,15 +1250,16 @@ export namespace dns_v1 { /** * dns.dnsKeys.list + * @desc Enumerate DnsKeys to a ResourceRecordSet collection. * @alias dns.dnsKeys.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.digestType - * @param {string} params.managedZone - * @param {integer=} params.maxResults - * @param {string=} params.pageToken - * @param {string} params.project + * @param {string=} params.digestType An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by 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 @@ -932,23 +1326,28 @@ export namespace dns_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * An optional comma-separated list of digest types to compute and display + * for key signing keys. If omitted, the recommended digest type will be + * computed and displayed. */ digestType?: string; /** - * + * The identifier of the requested DnsKey. */ dnsKeyId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -959,23 +1358,28 @@ export namespace dns_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * An optional comma-separated list of digest types to compute and display + * for key signing keys. If omitted, the recommended digest type will be + * computed and displayed. */ digestType?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. */ maxResults?: number; /** - * + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. */ pageToken?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -990,14 +1394,15 @@ export namespace dns_v1 { /** * dns.managedZoneOperations.get + * @desc Fetch the representation of an existing Operation. * @alias dns.managedZoneOperations.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.operation - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. + * @param {string} params.operation Identifies the operation addressed by this request. + * @param {string} params.project Identifies the project addressed by 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 @@ -1057,15 +1462,16 @@ export namespace dns_v1 { /** * dns.managedZoneOperations.list + * @desc Enumerate Operations for the given ManagedZone. * @alias dns.managedZoneOperations.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.managedZone - * @param {integer=} params.maxResults - * @param {string=} params.pageToken - * @param {string} params.project - * @param {string=} params.sortBy + * @param {string} params.managedZone Identifies the managed zone addressed by this request. + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {string=} params.sortBy Sorting criterion. The only supported values are START_TIME and 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 @@ -1146,19 +1552,21 @@ export namespace dns_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. */ managedZone?: string; /** - * + * Identifies the operation addressed by this request. */ operation?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -1170,23 +1578,25 @@ export namespace dns_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * Identifies the managed zone addressed by this request. */ managedZone?: string; /** - * + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. */ maxResults?: number; /** - * + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. */ pageToken?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; /** - * + * Sorting criterion. The only supported values are START_TIME and ID. */ sortBy?: string; } @@ -1201,6 +1611,7 @@ export namespace dns_v1 { /** * dns.managedZones.create + * @desc Create a new ManagedZone. * @example * * // BEFORE RUNNING: * // --------------- @@ -1262,8 +1673,8 @@ export namespace dns_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.project Identifies the project addressed by this request. * @param {().ManagedZone} 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. @@ -1326,6 +1737,7 @@ export namespace dns_v1 { /** * dns.managedZones.delete + * @desc Delete a previously created ManagedZone. * @example * * // BEFORE RUNNING: * // --------------- @@ -1384,9 +1796,9 @@ export namespace dns_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by 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 @@ -1447,6 +1859,7 @@ export namespace dns_v1 { /** * dns.managedZones.get + * @desc Fetch the representation of an existing ManagedZone. * @example * * // BEFORE RUNNING: * // --------------- @@ -1508,9 +1921,9 @@ export namespace dns_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by 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 @@ -1568,6 +1981,7 @@ export namespace dns_v1 { /** * dns.managedZones.list + * @desc Enumerate ManagedZones that have been created but not yet deleted. * @example * * // BEFORE RUNNING: * // --------------- @@ -1639,10 +2053,10 @@ export namespace dns_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.dnsName - * @param {integer=} params.maxResults - * @param {string=} params.pageToken - * @param {string} params.project + * @param {string=} params.dnsName Restricts the list to return only zones with this domain name. + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by 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 @@ -1704,13 +2118,14 @@ export namespace dns_v1 { /** * dns.managedZones.patch + * @desc Apply a partial update to an existing ManagedZone. * @alias dns.managedZones.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by this request. * @param {().ManagedZone} 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. @@ -1773,13 +2188,14 @@ export namespace dns_v1 { /** * dns.managedZones.update + * @desc Update an existing ManagedZone. * @alias dns.managedZones.update * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by this request. * @param {().ManagedZone} 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. @@ -1849,11 +2265,13 @@ export namespace dns_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; @@ -1870,15 +2288,18 @@ export namespace dns_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -1889,15 +2310,18 @@ export namespace dns_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -1909,19 +2333,21 @@ export namespace dns_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * Restricts the list to return only zones with this domain name. */ dnsName?: string; /** - * + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. */ maxResults?: number; /** - * + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. */ pageToken?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -1933,15 +2359,18 @@ export namespace dns_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; @@ -1958,15 +2387,18 @@ export namespace dns_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; @@ -1986,6 +2418,7 @@ export namespace dns_v1 { /** * dns.projects.get + * @desc Fetch the representation of an existing Project. * @example * * // BEFORE RUNNING: * // --------------- @@ -2043,8 +2476,8 @@ export namespace dns_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.project Identifies the project addressed by 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 @@ -2105,11 +2538,13 @@ export namespace dns_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -2124,6 +2559,8 @@ export namespace dns_v1 { /** * dns.resourceRecordSets.list + * @desc Enumerate ResourceRecordSets that have been created but not yet + * deleted. * @example * * // BEFORE RUNNING: * // --------------- @@ -2198,12 +2635,12 @@ export namespace dns_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.managedZone - * @param {integer=} params.maxResults - * @param {string=} params.name - * @param {string=} params.pageToken - * @param {string} params.project - * @param {string=} params.type + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.name Restricts the list to return only records with this fully qualified domain name. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {string=} params.type Restricts the list to return only records of this type. If present, the "name" parameter must also be present. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2280,27 +2717,32 @@ export namespace dns_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. */ maxResults?: number; /** - * + * Restricts the list to return only records with this fully qualified + * domain name. */ name?: string; /** - * + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. */ pageToken?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; /** - * + * Restricts the list to return only records of this type. If present, the + * "name" parameter must also be present. */ type?: string; } diff --git a/src/apis/dns/v1beta2.ts b/src/apis/dns/v1beta2.ts index f3d70599253..dc971f5413d 100644 --- a/src/apis/dns/v1beta2.ts +++ b/src/apis/dns/v1beta2.ts @@ -102,61 +102,201 @@ export namespace dns_v1beta2 { } } + /** + * A Change represents a set of ResourceRecordSet additions and deletions + * applied atomically to a ManagedZone. ResourceRecordSets within a + * ManagedZone are modified by creating a new Change element in the Changes + * collection. In turn the Changes collection also records the past + * modifications to the ResourceRecordSets in a ManagedZone. The current state + * of the ManagedZone is the sum effect of applying all Change elements in the + * Changes collection in sequence. + */ export interface Schema$Change { + /** + * Which ResourceRecordSets to add? + */ additions?: Schema$ResourceRecordSet[]; + /** + * Which ResourceRecordSets to remove? Must match existing data exactly. + */ deletions?: Schema$ResourceRecordSet[]; + /** + * Unique identifier for the resource; defined by the server (output only). + */ id?: string; + /** + * If the DNS queries for the zone will be served. + */ isServing?: boolean; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#change". */ kind?: string; + /** + * The time that this operation was started by the server (output only). + * This is in RFC3339 text format. + */ startTime?: string; + /** + * Status of the operation (output only). A status of "done" means + * that the request to update the authoritative servers has been sent, but + * the servers might not be updated yet. + */ status?: string; } + /** + * The response to a request to enumerate Changes to a ResourceRecordSets + * collection. + */ export interface Schema$ChangesListResponse { + /** + * The requested changes. + */ changes?: Schema$Change[]; header?: Schema$ResponseHeader; /** * Type of resource. */ kind?: string; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your pagination token. In + * this way you can retrieve the complete contents of even very large + * collections one page at a time. However, if the contents of the + * collection change between the first and last paginated list request, the + * set of all elements returned will be an inconsistent view of the + * collection. There is no way to retrieve a "snapshot" of + * collections larger than the maximum page size. + */ nextPageToken?: string; } + /** + * A DNSSEC key pair. + */ export interface Schema$DnsKey { + /** + * String mnemonic specifying the DNSSEC algorithm of this key. Immutable + * after creation time. + */ algorithm?: string; + /** + * The time that this resource was created in the control plane. This is in + * RFC3339 text format. Output only. + */ creationTime?: string; + /** + * A mutable string of at most 1024 characters associated with this resource + * for the user's convenience. Has no effect on the resource's + * function. + */ description?: string; + /** + * Cryptographic hashes of the DNSKEY resource record associated with this + * DnsKey. These digests are needed to construct a DS record that points at + * this DNS key. Output only. + */ digests?: Schema$DnsKeyDigest[]; + /** + * Unique identifier for the resource; defined by the server (output only). + */ id?: string; + /** + * Active keys will be used to sign subsequent changes to the ManagedZone. + * Inactive keys will still be present as DNSKEY Resource Records for the + * use of resolvers validating existing signatures. + */ isActive?: boolean; + /** + * Length of the key in bits. Specified at creation time then immutable. + */ keyLength?: number; + /** + * The key tag is a non-cryptographic hash of the a DNSKEY resource record + * associated with this DnsKey. The key tag can be used to identify a DNSKEY + * more quickly (but it is not a unique identifier). In particular, the key + * tag is used in a parent zone's DS record to point at the DNSKEY in + * this child ManagedZone. The key tag is a number in the range [0, 65535] + * and the algorithm to calculate it is specified in RFC4034 Appendix B. + * Output only. + */ keyTag?: number; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#dnsKey". */ kind?: string; + /** + * Base64 encoded public half of this key. Output only. + */ publicKey?: string; + /** + * One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type + * KEY_SIGNING have the Secure Entry Point flag set and, when active, will + * be used to sign only resource record sets of type DNSKEY. Otherwise, the + * Secure Entry Point flag will be cleared and this key will be used to sign + * only resource record sets of other types. Immutable after creation time. + */ type?: string; } export interface Schema$DnsKeyDigest { + /** + * The base-16 encoded bytes of this digest. Suitable for use in a DS + * resource record. + */ digest?: string; + /** + * Specifies the algorithm used to calculate this digest. + */ type?: string; } + /** + * The response to a request to enumerate DnsKeys in a ManagedZone. + */ export interface Schema$DnsKeysListResponse { + /** + * The requested resources. + */ dnsKeys?: Schema$DnsKey[]; header?: Schema$ResponseHeader; /** * Type of resource. */ kind?: string; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your pagination token. In + * this way you can retrieve the complete contents of even very large + * collections one page at a time. However, if the contents of the + * collection change between the first and last paginated list request, the + * set of all elements returned will be an inconsistent view of the + * collection. There is no way to retrieve a "snapshot" of + * collections larger than the maximum page size. + */ nextPageToken?: string; } + /** + * Parameters for DnsKey key generation. Used for generating initial keys for + * a new ManagedZone and as default when adding a new DnsKey. + */ export interface Schema$DnsKeySpec { + /** + * String mnemonic specifying the DNSSEC algorithm of this key. + */ algorithm?: string; + /** + * Length of the keys in bits. + */ keyLength?: number; + /** + * Specifies whether this is a key signing key (KSK) or a zone signing key + * (ZSK). Key signing keys have the Secure Entry Point flag set and, when + * active, will only be used to sign resource record sets of type DNSKEY. + * Zone signing keys do not have the Secure Entry Point flag set and will be + * used to sign all other types of resource record sets. + */ keyType?: string; /** * Identifies what kind of resource this is. Value: the fixed string @@ -164,34 +304,102 @@ export namespace dns_v1beta2 { */ kind?: string; } + /** + * A zone is a subtree of the DNS namespace under one administrative + * responsibility. A ManagedZone is a resource that represents a DNS zone + * hosted by the Cloud DNS service. + */ export interface Schema$ManagedZone { + /** + * The time that this resource was created on the server. This is in RFC3339 + * text format. Output only. + */ creationTime?: string; + /** + * A mutable string of at most 1024 characters associated with this resource + * for the user's convenience. Has no effect on the managed zone's + * function. + */ description?: string; + /** + * The DNS name of this managed zone, for instance "example.com.". + */ dnsName?: string; + /** + * DNSSEC configuration. + */ dnssecConfig?: Schema$ManagedZoneDnsSecConfig; + /** + * The presence for this field indicates that outbound forwarding is enabled + * for this zone. The value of this field contains the set of destinations + * to forward to. + */ forwardingConfig?: Schema$ManagedZoneForwardingConfig; + /** + * Unique identifier for the resource; defined by the server (output only) + */ id?: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#managedZone". */ kind?: string; + /** + * User labels. + */ labels?: {[key: string]: string;}; + /** + * User assigned name for this resource. Must be unique within the project. + * The name must be 1-63 characters long, must begin with a letter, end with + * a letter or digit, and only contain lowercase letters, digits or dashes. + */ name?: string; + /** + * Delegate your managed_zone to these virtual name servers; defined by the + * server (output only) + */ nameServers?: string[]; + /** + * Optionally specifies the NameServerSet for this ManagedZone. A + * NameServerSet is a set of DNS name servers that all host the same + * ManagedZones. Most users will leave this field unset. + */ nameServerSet?: string; + /** + * The presence of this field indicates that DNS Peering is enabled for this + * zone. The value of this field contains the network to peer with. + */ peeringConfig?: Schema$ManagedZonePeeringConfig; + /** + * For privately visible zones, the set of Virtual Private Cloud resources + * that the zone is visible from. + */ privateVisibilityConfig?: Schema$ManagedZonePrivateVisibilityConfig; + /** + * The zone's visibility: public zones are exposed to the Internet, + * while private zones are visible only to Virtual Private Cloud resources. + */ visibility?: string; } export interface Schema$ManagedZoneDnsSecConfig { + /** + * Specifies parameters that will be used for generating initial DnsKeys for + * this ManagedZone. Output only while state is not OFF. + */ defaultKeySpecs?: Schema$DnsKeySpec[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#managedZoneDnsSecConfig". */ kind?: string; + /** + * Specifies the mechanism used to provide authenticated denial-of-existence + * responses. Output only while state is not OFF. + */ nonExistence?: string; + /** + * Specifies whether DNSSEC is enabled, and what mode it is in. + */ state?: string; } export interface Schema$ManagedZoneForwardingConfig { @@ -200,9 +408,16 @@ export namespace dns_v1beta2 { * "dns#managedZoneForwardingConfig". */ kind?: string; + /** + * List of target name servers to forward to. Cloud DNS will select the best + * available name server if more than one target is given. + */ targetNameServers?: Schema$ManagedZoneForwardingConfigNameServerTarget[]; } export interface Schema$ManagedZoneForwardingConfigNameServerTarget { + /** + * IPv4 address of a target name server. + */ ipv4Address?: string; /** * Identifies what kind of resource this is. Value: the fixed string @@ -216,7 +431,21 @@ export namespace dns_v1beta2 { * Type of resource. */ kind?: string; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your page token. In this + * way you can retrieve the complete contents of even very large collections + * one page at a time. However, if the contents of the collection change + * between the first and last paginated list request, the set of all + * elements returned will be an inconsistent view of the collection. There + * is no way to retrieve a consistent snapshot of a collection larger than + * the maximum page size. + */ nextPageToken?: string; + /** + * The operation resources. + */ operations?: Schema$Operation[]; } export interface Schema$ManagedZonePeeringConfig { @@ -225,15 +454,30 @@ export namespace dns_v1beta2 { * "dns#managedZonePeeringConfig". */ kind?: string; + /** + * The network with which to peer. + */ targetNetwork?: Schema$ManagedZonePeeringConfigTargetNetwork; } 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. + */ deactivateTime?: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#managedZonePeeringConfigTargetNetwork". */ kind?: string; + /** + * The fully qualified URL of the VPC network to forward queries to. This + * should be formatted like + * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + */ networkUrl?: string; } export interface Schema$ManagedZonePrivateVisibilityConfig { @@ -242,6 +486,9 @@ export namespace dns_v1beta2 { * "dns#managedZonePrivateVisibilityConfig". */ kind?: string; + /** + * The list of VPC networks that can see this zone. + */ networks?: Schema$ManagedZonePrivateVisibilityConfigNetwork[]; } export interface Schema$ManagedZonePrivateVisibilityConfigNetwork { @@ -250,6 +497,11 @@ export namespace dns_v1beta2 { * "dns#managedZonePrivateVisibilityConfigNetwork". */ kind?: string; + /** + * The fully qualified URL of the VPC network to bind to. This should be + * formatted like + * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + */ networkUrl?: string; } export interface Schema$ManagedZonesListResponse { @@ -258,29 +510,92 @@ export namespace dns_v1beta2 { * Type of resource. */ kind?: string; + /** + * The managed zone resources. + */ managedZones?: Schema$ManagedZone[]; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your page token. In this + * way you can retrieve the complete contents of even very large collections + * one page at a time. However, if the contents of the collection change + * between the first and last paginated list request, the set of all + * elements returned will be an inconsistent view of the collection. There + * is no way to retrieve a consistent snapshot of a collection larger than + * the maximum page size. + */ nextPageToken?: string; } + /** + * An operation represents a successful mutation performed on a Cloud DNS + * resource. Operations provide: - An audit log of server resource mutations. + * - A way to recover/retry API calls in the case where the response is never + * received by the caller. Use the caller specified client_operation_id. + */ export interface Schema$Operation { + /** + * Only populated if the operation targeted a DnsKey (output only). + */ dnsKeyContext?: Schema$OperationDnsKeyContext; + /** + * Unique identifier for the resource. This is the client_operation_id if + * the client specified it when the mutation was initiated, otherwise, it is + * generated by the server. The name must be 1-63 characters long and match + * the regular expression [-a-z0-9]? (output only) + */ id?: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#operation". */ kind?: string; + /** + * The time that this operation was started by the server. This is in + * RFC3339 text format (output only). + */ startTime?: string; + /** + * Status of the operation. Can be one of the following: "PENDING" + * or "DONE" (output only). A status of "DONE" means + * that the request to update the authoritative servers has been sent, but + * the servers might not be updated yet. + */ status?: string; + /** + * Type of the operation. Operations include insert, update, and delete + * (output only). + */ type?: string; + /** + * User who requested the operation, for example: user@example.com. + * cloud-dns-system for operations automatically done by the system. (output + * only) + */ user?: string; + /** + * Only populated if the operation targeted a ManagedZone (output only). + */ zoneContext?: Schema$OperationManagedZoneContext; } export interface Schema$OperationDnsKeyContext { + /** + * The post-operation DnsKey resource. + */ newValue?: Schema$DnsKey; + /** + * The pre-operation DnsKey resource. + */ oldValue?: Schema$DnsKey; } export interface Schema$OperationManagedZoneContext { + /** + * The post-operation ManagedZone resource. + */ newValue?: Schema$ManagedZone; + /** + * The pre-operation ManagedZone resource. + */ oldValue?: Schema$ManagedZone; } export interface Schema$PoliciesListResponse { @@ -289,7 +604,21 @@ export namespace dns_v1beta2 { * Type of resource. */ kind?: string; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your page token. In this + * way you can retrieve the complete contents of even very large collections + * one page at a time. However, if the contents of the collection change + * between the first and last paginated list request, the set of all + * elements returned will be an inconsistent view of the collection. There + * is no way to retrieve a consistent snapshot of a collection larger than + * the maximum page size. + */ nextPageToken?: string; + /** + * The policy resources. + */ policies?: Schema$Policy[]; } export interface Schema$PoliciesPatchResponse { @@ -300,18 +629,53 @@ export namespace dns_v1beta2 { header?: Schema$ResponseHeader; policy?: Schema$Policy; } + /** + * A policy is a collection of DNS rules applied to one or more Virtual + * Private Cloud resources. + */ export interface Schema$Policy { + /** + * Sets an alternative name server for the associated networks. When + * specified, all DNS queries are forwarded to a name server that you + * choose. Names such as .internal are not available when an alternative + * name server is specified. + */ alternativeNameServerConfig?: Schema$PolicyAlternativeNameServerConfig; + /** + * A mutable string of at most 1024 characters associated with this resource + * for the user's convenience. Has no effect on the policy's + * function. + */ description?: string; + /** + * Allows networks bound to this policy to receive DNS queries sent by VMs + * or applications over VPN connections. When enabled, a virtual IP address + * will be allocated from each of the sub-networks that are bound to this + * policy. + */ enableInboundForwarding?: boolean; + /** + * Controls whether logging is enabled for the networks bound to this + * policy. Defaults to no logging if not set. + */ enableLogging?: boolean; + /** + * Unique identifier for the resource; defined by the server (output only). + */ id?: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#policy". */ kind?: string; + /** + * User assigned name for this policy. + */ name?: string; + /** + * List of network names specifying networks to which this policy is + * applied. + */ networks?: Schema$PolicyNetwork[]; } export interface Schema$PolicyAlternativeNameServerConfig { @@ -320,10 +684,19 @@ export namespace dns_v1beta2 { * "dns#policyAlternativeNameServerConfig". */ kind?: string; + /** + * Sets an alternative name server for the associated networks. When + * specified, all DNS queries are forwarded to a name server that you + * choose. Names such as .internal are not available when an alternative + * name server is specified. + */ targetNameServers?: Schema$PolicyAlternativeNameServerConfigTargetNameServer[]; } export interface Schema$PolicyAlternativeNameServerConfigTargetNameServer { + /** + * IPv4 address to forward to. + */ ipv4Address?: string; /** * Identifies what kind of resource this is. Value: the fixed string @@ -337,49 +710,140 @@ export namespace dns_v1beta2 { * "dns#policyNetwork". */ kind?: string; + /** + * The fully qualified URL of the VPC network to bind to. This should be + * formatted like + * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + */ networkUrl?: string; } + /** + * A project resource. The project is a top level container for resources + * including Cloud DNS ManagedZones. Projects can be created only in the APIs + * console. + */ export interface Schema$Project { + /** + * User assigned unique identifier for the resource (output only). + */ id?: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#project". */ kind?: string; + /** + * Unique numeric identifier for the resource; defined by the server (output + * only). + */ number?: string; + /** + * Quotas assigned to this project (output only). + */ quota?: Schema$Quota; } + /** + * Limits associated with a Project. + */ export interface Schema$Quota { + /** + * Maximum allowed number of DnsKeys per ManagedZone. + */ dnsKeysPerManagedZone?: number; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#quota". */ kind?: string; + /** + * Maximum allowed number of managed zones in the project. + */ managedZones?: number; + /** + * Maximum allowed number of managed zones which can be attached to a + * network. + */ managedZonesPerNetwork?: number; + /** + * Maximum allowed number of networks to which a privately scoped zone can + * be attached. + */ networksPerManagedZone?: number; + /** + * Maximum allowed number of networks per policy. + */ networksPerPolicy?: number; + /** + * Maximum allowed number of policies per project. + */ policies?: number; + /** + * Maximum allowed number of ResourceRecords per ResourceRecordSet. + */ resourceRecordsPerRrset?: number; + /** + * Maximum allowed number of ResourceRecordSets to add per + * ChangesCreateRequest. + */ rrsetAdditionsPerChange?: number; + /** + * Maximum allowed number of ResourceRecordSets to delete per + * ChangesCreateRequest. + */ rrsetDeletionsPerChange?: number; + /** + * Maximum allowed number of ResourceRecordSets per zone in the project. + */ rrsetsPerManagedZone?: number; + /** + * Maximum allowed number of target name servers per managed forwarding + * zone. + */ targetNameServersPerManagedZone?: number; + /** + * Maximum allowed number of alternative target name servers per policy. + */ targetNameServersPerPolicy?: number; + /** + * Maximum allowed size for total rrdata in one ChangesCreateRequest in + * bytes. + */ totalRrdataSizePerChange?: number; + /** + * DNSSEC algorithm and key length types that can be used for DnsKeys. + */ whitelistedKeySpecs?: Schema$DnsKeySpec[]; } + /** + * A unit of data that will be returned by the DNS servers. + */ export interface Schema$ResourceRecordSet { /** * Identifies what kind of resource this is. Value: the fixed string * "dns#resourceRecordSet". */ kind?: string; + /** + * For example, www.example.com. + */ name?: string; + /** + * As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see + * examples. + */ rrdatas?: string[]; + /** + * As defined in RFC 4034 (section 3.2). + */ signatureRrdatas?: string[]; + /** + * Number of seconds that this ResourceRecordSet can be cached by resolvers. + */ ttl?: number; + /** + * The identifier of a supported record type. See the list of Supported DNS + * record types. + */ type?: string; } export interface Schema$ResourceRecordSetsListResponse { @@ -388,10 +852,32 @@ export namespace dns_v1beta2 { * Type of resource. */ kind?: string; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your pagination token. In + * this way you can retrieve the complete contents of even very large + * collections one page at a time. However, if the contents of the + * collection change between the first and last paginated list request, the + * set of all elements returned will be an inconsistent view of the + * collection. There is no way to retrieve a consistent snapshot of a + * collection larger than the maximum page size. + */ nextPageToken?: string; + /** + * The resource record set resources. + */ rrsets?: Schema$ResourceRecordSet[]; } + /** + * Elements common to every response. + */ export interface Schema$ResponseHeader { + /** + * For mutating operation requests that completed successfully. This is the + * client_operation_id if the client specified it, otherwise it is generated + * by the server (output only). + */ operationId?: string; } @@ -405,13 +891,14 @@ export namespace dns_v1beta2 { /** * dns.changes.create + * @desc Atomically update the ResourceRecordSet collection. * @alias dns.changes.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by this request. * @param {().Change} 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. @@ -473,14 +960,15 @@ export namespace dns_v1beta2 { /** * dns.changes.get + * @desc Fetch the representation of an existing Change. * @alias dns.changes.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.changeId - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string} params.changeId The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by 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 @@ -538,16 +1026,17 @@ export namespace dns_v1beta2 { /** * dns.changes.list + * @desc Enumerate Changes to a ResourceRecordSet collection. * @alias dns.changes.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.managedZone - * @param {integer=} params.maxResults - * @param {string=} params.pageToken - * @param {string} params.project - * @param {string=} params.sortBy - * @param {string=} params.sortOrder + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {string=} params.sortBy Sorting criterion. The only supported value is change sequence. + * @param {string=} params.sortOrder Sorting order direction: 'ascending' or 'descending'. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -614,15 +1103,18 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; @@ -638,19 +1130,23 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * The identifier of the requested change, from a previous + * ResourceRecordSetsChangeResponse. */ changeId?: string; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -661,27 +1157,30 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. */ maxResults?: number; /** - * + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. */ pageToken?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; /** - * + * Sorting criterion. The only supported value is change sequence. */ sortBy?: string; /** - * + * Sorting order direction: 'ascending' or 'descending'. */ sortOrder?: string; } @@ -696,15 +1195,16 @@ export namespace dns_v1beta2 { /** * dns.dnsKeys.get + * @desc Fetch the representation of an existing DnsKey. * @alias dns.dnsKeys.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string=} params.digestType - * @param {string} params.dnsKeyId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string=} params.digestType An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed. + * @param {string} params.dnsKeyId The identifier of the requested DnsKey. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by 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 @@ -762,15 +1262,16 @@ export namespace dns_v1beta2 { /** * dns.dnsKeys.list + * @desc Enumerate DnsKeys to a ResourceRecordSet collection. * @alias dns.dnsKeys.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.digestType - * @param {string} params.managedZone - * @param {integer=} params.maxResults - * @param {string=} params.pageToken - * @param {string} params.project + * @param {string=} params.digestType An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by 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 @@ -837,23 +1338,28 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * An optional comma-separated list of digest types to compute and display + * for key signing keys. If omitted, the recommended digest type will be + * computed and displayed. */ digestType?: string; /** - * + * The identifier of the requested DnsKey. */ dnsKeyId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -864,23 +1370,28 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * An optional comma-separated list of digest types to compute and display + * for key signing keys. If omitted, the recommended digest type will be + * computed and displayed. */ digestType?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. */ maxResults?: number; /** - * + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. */ pageToken?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -895,14 +1406,15 @@ export namespace dns_v1beta2 { /** * dns.managedZoneOperations.get + * @desc Fetch the representation of an existing Operation. * @alias dns.managedZoneOperations.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.operation - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. + * @param {string} params.operation Identifies the operation addressed by this request. + * @param {string} params.project Identifies the project addressed by 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 @@ -962,15 +1474,16 @@ export namespace dns_v1beta2 { /** * dns.managedZoneOperations.list + * @desc Enumerate Operations for the given ManagedZone. * @alias dns.managedZoneOperations.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.managedZone - * @param {integer=} params.maxResults - * @param {string=} params.pageToken - * @param {string} params.project - * @param {string=} params.sortBy + * @param {string} params.managedZone Identifies the managed zone addressed by this request. + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {string=} params.sortBy Sorting criterion. The only supported values are START_TIME and 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 @@ -1051,19 +1564,21 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. */ managedZone?: string; /** - * + * Identifies the operation addressed by this request. */ operation?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -1075,23 +1590,25 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * Identifies the managed zone addressed by this request. */ managedZone?: string; /** - * + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. */ maxResults?: number; /** - * + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. */ pageToken?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; /** - * + * Sorting criterion. The only supported values are START_TIME and ID. */ sortBy?: string; } @@ -1106,12 +1623,13 @@ export namespace dns_v1beta2 { /** * dns.managedZones.create + * @desc Create a new ManagedZone. * @alias dns.managedZones.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.project Identifies the project addressed by this request. * @param {().ManagedZone} 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. @@ -1174,13 +1692,14 @@ export namespace dns_v1beta2 { /** * dns.managedZones.delete + * @desc Delete a previously created ManagedZone. * @alias dns.managedZones.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by 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 @@ -1242,13 +1761,14 @@ export namespace dns_v1beta2 { /** * dns.managedZones.get + * @desc Fetch the representation of an existing ManagedZone. * @alias dns.managedZones.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by 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 @@ -1307,14 +1827,15 @@ export namespace dns_v1beta2 { /** * dns.managedZones.list + * @desc Enumerate ManagedZones that have been created but not yet deleted. * @alias dns.managedZones.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.dnsName - * @param {integer=} params.maxResults - * @param {string=} params.pageToken - * @param {string} params.project + * @param {string=} params.dnsName Restricts the list to return only zones with this domain name. + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by 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 @@ -1376,13 +1897,14 @@ export namespace dns_v1beta2 { /** * dns.managedZones.patch + * @desc Apply a partial update to an existing ManagedZone. * @alias dns.managedZones.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by this request. * @param {().ManagedZone} 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. @@ -1446,13 +1968,14 @@ export namespace dns_v1beta2 { /** * dns.managedZones.update + * @desc Update an existing ManagedZone. * @alias dns.managedZones.update * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by this request. * @param {().ManagedZone} 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. @@ -1523,11 +2046,13 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; @@ -1544,15 +2069,18 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -1563,15 +2091,18 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -1583,19 +2114,21 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * Restricts the list to return only zones with this domain name. */ dnsName?: string; /** - * + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. */ maxResults?: number; /** - * + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. */ pageToken?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -1607,15 +2140,18 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; @@ -1632,15 +2168,18 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; @@ -1660,12 +2199,13 @@ export namespace dns_v1beta2 { /** * dns.policies.create + * @desc Create a new Policy * @alias dns.policies.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.project Identifies the project addressed by this request. * @param {().Policy} 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. @@ -1725,13 +2265,15 @@ export namespace dns_v1beta2 { /** * dns.policies.delete + * @desc Delete a previously created Policy. Will fail if the policy is + * still being referenced by a network. * @alias dns.policies.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.policy - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.policy User given friendly name of the policy addressed by this request. + * @param {string} params.project Identifies the project addressed by 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 @@ -1790,13 +2332,14 @@ export namespace dns_v1beta2 { /** * dns.policies.get + * @desc Fetch the representation of an existing Policy. * @alias dns.policies.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.policy - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.policy User given friendly name of the policy addressed by this request. + * @param {string} params.project Identifies the project addressed by 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 @@ -1853,13 +2396,14 @@ export namespace dns_v1beta2 { /** * dns.policies.list + * @desc Enumerate all Policies associated with a project. * @alias dns.policies.list * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.maxResults - * @param {string=} params.pageToken - * @param {string} params.project + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by 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 @@ -1920,13 +2464,14 @@ export namespace dns_v1beta2 { /** * dns.policies.patch + * @desc Apply a partial update to an existing Policy. * @alias dns.policies.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.policy - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.policy User given friendly name of the policy addressed by this request. + * @param {string} params.project Identifies the project addressed by this request. * @param {().Policy} 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. @@ -1989,13 +2534,14 @@ export namespace dns_v1beta2 { /** * dns.policies.update + * @desc Update an existing Policy. * @alias dns.policies.update * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.policy - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.policy User given friendly name of the policy addressed by this request. + * @param {string} params.project Identifies the project addressed by this request. * @param {().Policy} 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. @@ -2063,11 +2609,13 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; @@ -2083,15 +2631,17 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * User given friendly name of the policy addressed by this request. */ policy?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -2102,15 +2652,17 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * User given friendly name of the policy addressed by this request. */ policy?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -2121,15 +2673,17 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. */ maxResults?: number; /** - * + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. */ pageToken?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -2140,15 +2694,17 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * User given friendly name of the policy addressed by this request. */ policy?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; @@ -2164,15 +2720,17 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * User given friendly name of the policy addressed by this request. */ policy?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; @@ -2192,12 +2750,13 @@ export namespace dns_v1beta2 { /** * dns.projects.get + * @desc Fetch the representation of an existing Project. * @alias dns.projects.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.project Identifies the project addressed by 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 @@ -2258,11 +2817,13 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -2277,16 +2838,18 @@ export namespace dns_v1beta2 { /** * dns.resourceRecordSets.list + * @desc Enumerate ResourceRecordSets that have been created but not yet + * deleted. * @alias dns.resourceRecordSets.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.managedZone - * @param {integer=} params.maxResults - * @param {string=} params.name - * @param {string=} params.pageToken - * @param {string} params.project - * @param {string=} params.type + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.name Restricts the list to return only records with this fully qualified domain name. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {string=} params.type Restricts the list to return only records of this type. If present, the "name" parameter must also be present. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2363,27 +2926,32 @@ export namespace dns_v1beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. */ maxResults?: number; /** - * + * Restricts the list to return only records with this fully qualified + * domain name. */ name?: string; /** - * + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. */ pageToken?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; /** - * + * Restricts the list to return only records of this type. If present, the + * "name" parameter must also be present. */ type?: string; } diff --git a/src/apis/dns/v2beta1.ts b/src/apis/dns/v2beta1.ts index c99b9a87f87..3f7fa4fdc83 100644 --- a/src/apis/dns/v2beta1.ts +++ b/src/apis/dns/v2beta1.ts @@ -100,61 +100,201 @@ export namespace dns_v2beta1 { } } + /** + * A Change represents a set of ResourceRecordSet additions and deletions + * applied atomically to a ManagedZone. ResourceRecordSets within a + * ManagedZone are modified by creating a new Change element in the Changes + * collection. In turn the Changes collection also records the past + * modifications to the ResourceRecordSets in a ManagedZone. The current state + * of the ManagedZone is the sum effect of applying all Change elements in the + * Changes collection in sequence. + */ export interface Schema$Change { + /** + * Which ResourceRecordSets to add? + */ additions?: Schema$ResourceRecordSet[]; + /** + * Which ResourceRecordSets to remove? Must match existing data exactly. + */ deletions?: Schema$ResourceRecordSet[]; + /** + * Unique identifier for the resource; defined by the server (output only). + */ id?: string; + /** + * If the DNS queries for the zone will be served. + */ isServing?: boolean; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#change". */ kind?: string; + /** + * The time that this operation was started by the server (output only). + * This is in RFC3339 text format. + */ startTime?: string; + /** + * Status of the operation (output only). A status of "done" means + * that the request to update the authoritative servers has been sent, but + * the servers might not be updated yet. + */ status?: string; } + /** + * The response to a request to enumerate Changes to a ResourceRecordSets + * collection. + */ export interface Schema$ChangesListResponse { + /** + * The requested changes. + */ changes?: Schema$Change[]; header?: Schema$ResponseHeader; /** * Type of resource. */ kind?: string; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your pagination token. In + * this way you can retrieve the complete contents of even very large + * collections one page at a time. However, if the contents of the + * collection change between the first and last paginated list request, the + * set of all elements returned will be an inconsistent view of the + * collection. There is no way to retrieve a "snapshot" of + * collections larger than the maximum page size. + */ nextPageToken?: string; } + /** + * A DNSSEC key pair. + */ export interface Schema$DnsKey { + /** + * String mnemonic specifying the DNSSEC algorithm of this key. Immutable + * after creation time. + */ algorithm?: string; + /** + * The time that this resource was created in the control plane. This is in + * RFC3339 text format. Output only. + */ creationTime?: string; + /** + * A mutable string of at most 1024 characters associated with this resource + * for the user's convenience. Has no effect on the resource's + * function. + */ description?: string; + /** + * Cryptographic hashes of the DNSKEY resource record associated with this + * DnsKey. These digests are needed to construct a DS record that points at + * this DNS key. Output only. + */ digests?: Schema$DnsKeyDigest[]; + /** + * Unique identifier for the resource; defined by the server (output only). + */ id?: string; + /** + * Active keys will be used to sign subsequent changes to the ManagedZone. + * Inactive keys will still be present as DNSKEY Resource Records for the + * use of resolvers validating existing signatures. + */ isActive?: boolean; + /** + * Length of the key in bits. Specified at creation time then immutable. + */ keyLength?: number; + /** + * The key tag is a non-cryptographic hash of the a DNSKEY resource record + * associated with this DnsKey. The key tag can be used to identify a DNSKEY + * more quickly (but it is not a unique identifier). In particular, the key + * tag is used in a parent zone's DS record to point at the DNSKEY in + * this child ManagedZone. The key tag is a number in the range [0, 65535] + * and the algorithm to calculate it is specified in RFC4034 Appendix B. + * Output only. + */ keyTag?: number; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#dnsKey". */ kind?: string; + /** + * Base64 encoded public half of this key. Output only. + */ publicKey?: string; + /** + * One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type + * KEY_SIGNING have the Secure Entry Point flag set and, when active, will + * be used to sign only resource record sets of type DNSKEY. Otherwise, the + * Secure Entry Point flag will be cleared and this key will be used to sign + * only resource record sets of other types. Immutable after creation time. + */ type?: string; } export interface Schema$DnsKeyDigest { + /** + * The base-16 encoded bytes of this digest. Suitable for use in a DS + * resource record. + */ digest?: string; + /** + * Specifies the algorithm used to calculate this digest. + */ type?: string; } + /** + * The response to a request to enumerate DnsKeys in a ManagedZone. + */ export interface Schema$DnsKeysListResponse { + /** + * The requested resources. + */ dnsKeys?: Schema$DnsKey[]; header?: Schema$ResponseHeader; /** * Type of resource. */ kind?: string; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your pagination token. In + * this way you can retrieve the complete contents of even very large + * collections one page at a time. However, if the contents of the + * collection change between the first and last paginated list request, the + * set of all elements returned will be an inconsistent view of the + * collection. There is no way to retrieve a "snapshot" of + * collections larger than the maximum page size. + */ nextPageToken?: string; } + /** + * Parameters for DnsKey key generation. Used for generating initial keys for + * a new ManagedZone and as default when adding a new DnsKey. + */ export interface Schema$DnsKeySpec { + /** + * String mnemonic specifying the DNSSEC algorithm of this key. + */ algorithm?: string; + /** + * Length of the keys in bits. + */ keyLength?: number; + /** + * Specifies whether this is a key signing key (KSK) or a zone signing key + * (ZSK). Key signing keys have the Secure Entry Point flag set and, when + * active, will only be used to sign resource record sets of type DNSKEY. + * Zone signing keys do not have the Secure Entry Point flag set and will be + * used to sign all other types of resource record sets. + */ keyType?: string; /** * Identifies what kind of resource this is. Value: the fixed string @@ -162,32 +302,91 @@ export namespace dns_v2beta1 { */ kind?: string; } + /** + * A zone is a subtree of the DNS namespace under one administrative + * responsibility. A ManagedZone is a resource that represents a DNS zone + * hosted by the Cloud DNS service. + */ export interface Schema$ManagedZone { + /** + * The time that this resource was created on the server. This is in RFC3339 + * text format. Output only. + */ creationTime?: string; + /** + * A mutable string of at most 1024 characters associated with this resource + * for the user's convenience. Has no effect on the managed zone's + * function. + */ description?: string; + /** + * The DNS name of this managed zone, for instance "example.com.". + */ dnsName?: string; + /** + * DNSSEC configuration. + */ dnssecConfig?: Schema$ManagedZoneDnsSecConfig; + /** + * Unique identifier for the resource; defined by the server (output only) + */ id?: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#managedZone". */ kind?: string; + /** + * User labels. + */ labels?: {[key: string]: string;}; + /** + * User assigned name for this resource. Must be unique within the project. + * The name must be 1-63 characters long, must begin with a letter, end with + * a letter or digit, and only contain lowercase letters, digits or dashes. + */ name?: string; + /** + * Delegate your managed_zone to these virtual name servers; defined by the + * server (output only) + */ nameServers?: string[]; + /** + * Optionally specifies the NameServerSet for this ManagedZone. A + * NameServerSet is a set of DNS name servers that all host the same + * ManagedZones. Most users will leave this field unset. + */ nameServerSet?: string; + /** + * For privately visible zones, the set of Virtual Private Cloud resources + * that the zone is visible from. + */ privateVisibilityConfig?: Schema$ManagedZonePrivateVisibilityConfig; + /** + * The zone's visibility: public zones are exposed to the Internet, + * while private zones are visible only to Virtual Private Cloud resources. + */ visibility?: string; } export interface Schema$ManagedZoneDnsSecConfig { + /** + * Specifies parameters that will be used for generating initial DnsKeys for + * this ManagedZone. Output only while state is not OFF. + */ defaultKeySpecs?: Schema$DnsKeySpec[]; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#managedZoneDnsSecConfig". */ kind?: string; + /** + * Specifies the mechanism used to provide authenticated denial-of-existence + * responses. Output only while state is not OFF. + */ nonExistence?: string; + /** + * Specifies whether DNSSEC is enabled, and what mode it is in. + */ state?: string; } export interface Schema$ManagedZoneOperationsListResponse { @@ -196,7 +395,21 @@ export namespace dns_v2beta1 { * Type of resource. */ kind?: string; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your page token. In this + * way you can retrieve the complete contents of even very large collections + * one page at a time. However, if the contents of the collection change + * between the first and last paginated list request, the set of all + * elements returned will be an inconsistent view of the collection. There + * is no way to retrieve a consistent snapshot of a collection larger than + * the maximum page size. + */ nextPageToken?: string; + /** + * The operation resources. + */ operations?: Schema$Operation[]; } export interface Schema$ManagedZonePrivateVisibilityConfig { @@ -205,6 +418,9 @@ export namespace dns_v2beta1 { * "dns#managedZonePrivateVisibilityConfig". */ kind?: string; + /** + * The list of VPC networks that can see this zone. + */ networks?: Schema$ManagedZonePrivateVisibilityConfigNetwork[]; } export interface Schema$ManagedZonePrivateVisibilityConfigNetwork { @@ -213,6 +429,11 @@ export namespace dns_v2beta1 { * "dns#managedZonePrivateVisibilityConfigNetwork". */ kind?: string; + /** + * The fully qualified URL of the VPC network to bind to. This should be + * formatted like + * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + */ networkUrl?: string; } export interface Schema$ManagedZonesListResponse { @@ -221,68 +442,204 @@ export namespace dns_v2beta1 { * Type of resource. */ kind?: string; + /** + * The managed zone resources. + */ managedZones?: Schema$ManagedZone[]; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your page token. In this + * way you can retrieve the complete contents of even very large collections + * one page at a time. However, if the contents of the collection change + * between the first and last paginated list request, the set of all + * elements returned will be an inconsistent view of the collection. There + * is no way to retrieve a consistent snapshot of a collection larger than + * the maximum page size. + */ nextPageToken?: string; } + /** + * An operation represents a successful mutation performed on a Cloud DNS + * resource. Operations provide: - An audit log of server resource mutations. + * - A way to recover/retry API calls in the case where the response is never + * received by the caller. Use the caller specified client_operation_id. + */ export interface Schema$Operation { + /** + * Only populated if the operation targeted a DnsKey (output only). + */ dnsKeyContext?: Schema$OperationDnsKeyContext; + /** + * Unique identifier for the resource. This is the client_operation_id if + * the client specified it when the mutation was initiated, otherwise, it is + * generated by the server. The name must be 1-63 characters long and match + * the regular expression [-a-z0-9]? (output only) + */ id?: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#operation". */ kind?: string; + /** + * The time that this operation was started by the server. This is in + * RFC3339 text format (output only). + */ startTime?: string; + /** + * Status of the operation. Can be one of the following: "PENDING" + * or "DONE" (output only). A status of "DONE" means + * that the request to update the authoritative servers has been sent, but + * the servers might not be updated yet. + */ status?: string; + /** + * Type of the operation. Operations include insert, update, and delete + * (output only). + */ type?: string; + /** + * User who requested the operation, for example: user@example.com. + * cloud-dns-system for operations automatically done by the system. (output + * only) + */ user?: string; + /** + * Only populated if the operation targeted a ManagedZone (output only). + */ zoneContext?: Schema$OperationManagedZoneContext; } export interface Schema$OperationDnsKeyContext { + /** + * The post-operation DnsKey resource. + */ newValue?: Schema$DnsKey; + /** + * The pre-operation DnsKey resource. + */ oldValue?: Schema$DnsKey; } export interface Schema$OperationManagedZoneContext { + /** + * The post-operation ManagedZone resource. + */ newValue?: Schema$ManagedZone; + /** + * The pre-operation ManagedZone resource. + */ oldValue?: Schema$ManagedZone; } + /** + * A project resource. The project is a top level container for resources + * including Cloud DNS ManagedZones. Projects can be created only in the APIs + * console. + */ export interface Schema$Project { + /** + * User assigned unique identifier for the resource (output only). + */ id?: string; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#project". */ kind?: string; + /** + * Unique numeric identifier for the resource; defined by the server (output + * only). + */ number?: string; + /** + * Quotas assigned to this project (output only). + */ quota?: Schema$Quota; } + /** + * Limits associated with a Project. + */ export interface Schema$Quota { + /** + * Maximum allowed number of DnsKeys per ManagedZone. + */ dnsKeysPerManagedZone?: number; /** * Identifies what kind of resource this is. Value: the fixed string * "dns#quota". */ kind?: string; + /** + * Maximum allowed number of managed zones in the project. + */ managedZones?: number; + /** + * Maximum allowed number of managed zones which can be attached to a + * network. + */ managedZonesPerNetwork?: number; + /** + * Maximum allowed number of networks to which a privately scoped zone can + * be attached. + */ networksPerManagedZone?: number; + /** + * Maximum allowed number of ResourceRecords per ResourceRecordSet. + */ resourceRecordsPerRrset?: number; + /** + * Maximum allowed number of ResourceRecordSets to add per + * ChangesCreateRequest. + */ rrsetAdditionsPerChange?: number; + /** + * Maximum allowed number of ResourceRecordSets to delete per + * ChangesCreateRequest. + */ rrsetDeletionsPerChange?: number; + /** + * Maximum allowed number of ResourceRecordSets per zone in the project. + */ rrsetsPerManagedZone?: number; + /** + * Maximum allowed size for total rrdata in one ChangesCreateRequest in + * bytes. + */ totalRrdataSizePerChange?: number; + /** + * DNSSEC algorithm and key length types that can be used for DnsKeys. + */ whitelistedKeySpecs?: Schema$DnsKeySpec[]; } + /** + * A unit of data that will be returned by the DNS servers. + */ export interface Schema$ResourceRecordSet { /** * Identifies what kind of resource this is. Value: the fixed string * "dns#resourceRecordSet". */ kind?: string; + /** + * For example, www.example.com. + */ name?: string; + /** + * As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see + * examples. + */ rrdatas?: string[]; + /** + * As defined in RFC 4034 (section 3.2). + */ signatureRrdatas?: string[]; + /** + * Number of seconds that this ResourceRecordSet can be cached by resolvers. + */ ttl?: number; + /** + * The identifier of a supported record type. See the list of Supported DNS + * record types. + */ type?: string; } export interface Schema$ResourceRecordSetsListResponse { @@ -291,10 +648,32 @@ export namespace dns_v2beta1 { * Type of resource. */ kind?: string; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your pagination token. In + * this way you can retrieve the complete contents of even very large + * collections one page at a time. However, if the contents of the + * collection change between the first and last paginated list request, the + * set of all elements returned will be an inconsistent view of the + * collection. There is no way to retrieve a consistent snapshot of a + * collection larger than the maximum page size. + */ nextPageToken?: string; + /** + * The resource record set resources. + */ rrsets?: Schema$ResourceRecordSet[]; } + /** + * Elements common to every response. + */ export interface Schema$ResponseHeader { + /** + * For mutating operation requests that completed successfully. This is the + * client_operation_id if the client specified it, otherwise it is generated + * by the server (output only). + */ operationId?: string; } @@ -308,6 +687,7 @@ export namespace dns_v2beta1 { /** * dns.changes.create + * @desc Atomically update the ResourceRecordSet collection. * @example * * // BEFORE RUNNING: * // --------------- @@ -373,9 +753,9 @@ export namespace dns_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by this request. * @param {().Change} 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. @@ -437,6 +817,7 @@ export namespace dns_v2beta1 { /** * dns.changes.get + * @desc Fetch the representation of an existing Change. * @example * * // BEFORE RUNNING: * // --------------- @@ -502,10 +883,10 @@ export namespace dns_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.changeId - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string} params.changeId The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse. + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by 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 @@ -563,6 +944,7 @@ export namespace dns_v2beta1 { /** * dns.changes.list + * @desc Enumerate Changes to a ResourceRecordSet collection. * @example * * // BEFORE RUNNING: * // --------------- @@ -637,12 +1019,12 @@ export namespace dns_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.managedZone - * @param {integer=} params.maxResults - * @param {string=} params.pageToken - * @param {string} params.project - * @param {string=} params.sortBy - * @param {string=} params.sortOrder + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {string=} params.sortBy Sorting criterion. The only supported value is change sequence. + * @param {string=} params.sortOrder Sorting order direction: 'ascending' or 'descending'. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -709,15 +1091,18 @@ export namespace dns_v2beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; @@ -733,19 +1118,23 @@ export namespace dns_v2beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * The identifier of the requested change, from a previous + * ResourceRecordSetsChangeResponse. */ changeId?: string; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -756,27 +1145,30 @@ export namespace dns_v2beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. */ maxResults?: number; /** - * + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. */ pageToken?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; /** - * + * Sorting criterion. The only supported value is change sequence. */ sortBy?: string; /** - * + * Sorting order direction: 'ascending' or 'descending'. */ sortOrder?: string; } @@ -791,6 +1183,7 @@ export namespace dns_v2beta1 { /** * dns.dnsKeys.get + * @desc Fetch the representation of an existing DnsKey. * @example * * // BEFORE RUNNING: * // --------------- @@ -855,11 +1248,11 @@ export namespace dns_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string=} params.digestType - * @param {string} params.dnsKeyId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string=} params.digestType An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed. + * @param {string} params.dnsKeyId The identifier of the requested DnsKey. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by 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 @@ -917,6 +1310,7 @@ export namespace dns_v2beta1 { /** * dns.dnsKeys.list + * @desc Enumerate DnsKeys to a ResourceRecordSet collection. * @example * * // BEFORE RUNNING: * // --------------- @@ -991,11 +1385,11 @@ export namespace dns_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.digestType - * @param {string} params.managedZone - * @param {integer=} params.maxResults - * @param {string=} params.pageToken - * @param {string} params.project + * @param {string=} params.digestType An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by 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 @@ -1062,23 +1456,28 @@ export namespace dns_v2beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * An optional comma-separated list of digest types to compute and display + * for key signing keys. If omitted, the recommended digest type will be + * computed and displayed. */ digestType?: string; /** - * + * The identifier of the requested DnsKey. */ dnsKeyId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -1089,23 +1488,28 @@ export namespace dns_v2beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * An optional comma-separated list of digest types to compute and display + * for key signing keys. If omitted, the recommended digest type will be + * computed and displayed. */ digestType?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. */ maxResults?: number; /** - * + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. */ pageToken?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -1120,6 +1524,7 @@ export namespace dns_v2beta1 { /** * dns.managedZoneOperations.get + * @desc Fetch the representation of an existing Operation. * @example * * // BEFORE RUNNING: * // --------------- @@ -1183,10 +1588,10 @@ export namespace dns_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.operation - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. + * @param {string} params.operation Identifies the operation addressed by this request. + * @param {string} params.project Identifies the project addressed by 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 @@ -1246,6 +1651,7 @@ export namespace dns_v2beta1 { /** * dns.managedZoneOperations.list + * @desc Enumerate Operations for the given ManagedZone. * @example * * // BEFORE RUNNING: * // --------------- @@ -1320,11 +1726,11 @@ export namespace dns_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.managedZone - * @param {integer=} params.maxResults - * @param {string=} params.pageToken - * @param {string} params.project - * @param {string=} params.sortBy + * @param {string} params.managedZone Identifies the managed zone addressed by this request. + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {string=} params.sortBy Sorting criterion. The only supported values are START_TIME and 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 @@ -1405,19 +1811,21 @@ export namespace dns_v2beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. */ managedZone?: string; /** - * + * Identifies the operation addressed by this request. */ operation?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -1429,23 +1837,25 @@ export namespace dns_v2beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * Identifies the managed zone addressed by this request. */ managedZone?: string; /** - * + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. */ maxResults?: number; /** - * + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. */ pageToken?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; /** - * + * Sorting criterion. The only supported values are START_TIME and ID. */ sortBy?: string; } @@ -1460,6 +1870,7 @@ export namespace dns_v2beta1 { /** * dns.managedZones.create + * @desc Create a new ManagedZone. * @example * * // BEFORE RUNNING: * // --------------- @@ -1521,8 +1932,8 @@ export namespace dns_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.project Identifies the project addressed by this request. * @param {().ManagedZone} 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. @@ -1585,6 +1996,7 @@ export namespace dns_v2beta1 { /** * dns.managedZones.delete + * @desc Delete a previously created ManagedZone. * @example * * // BEFORE RUNNING: * // --------------- @@ -1646,9 +2058,9 @@ export namespace dns_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by 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 @@ -1710,6 +2122,7 @@ export namespace dns_v2beta1 { /** * dns.managedZones.get + * @desc Fetch the representation of an existing ManagedZone. * @example * * // BEFORE RUNNING: * // --------------- @@ -1771,9 +2184,9 @@ export namespace dns_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by 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 @@ -1832,6 +2245,7 @@ export namespace dns_v2beta1 { /** * dns.managedZones.list + * @desc Enumerate ManagedZones that have been created but not yet deleted. * @example * * // BEFORE RUNNING: * // --------------- @@ -1903,10 +2317,10 @@ export namespace dns_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.dnsName - * @param {integer=} params.maxResults - * @param {string=} params.pageToken - * @param {string} params.project + * @param {string=} params.dnsName Restricts the list to return only zones with this domain name. + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by 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 @@ -1968,6 +2382,7 @@ export namespace dns_v2beta1 { /** * dns.managedZones.patch + * @desc Apply a partial update to an existing ManagedZone. * @example * * // BEFORE RUNNING: * // --------------- @@ -2035,9 +2450,9 @@ export namespace dns_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by this request. * @param {().ManagedZone} 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. @@ -2101,6 +2516,7 @@ export namespace dns_v2beta1 { /** * dns.managedZones.update + * @desc Update an existing ManagedZone. * @example * * // BEFORE RUNNING: * // --------------- @@ -2168,9 +2584,9 @@ export namespace dns_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.managedZone - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {string} params.project Identifies the project addressed by this request. * @param {().ManagedZone} 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. @@ -2241,11 +2657,13 @@ export namespace dns_v2beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; @@ -2262,15 +2680,18 @@ export namespace dns_v2beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -2281,15 +2702,18 @@ export namespace dns_v2beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -2301,19 +2725,21 @@ export namespace dns_v2beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * Restricts the list to return only zones with this domain name. */ dnsName?: string; /** - * + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. */ maxResults?: number; /** - * + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. */ pageToken?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -2325,15 +2751,18 @@ export namespace dns_v2beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; @@ -2350,15 +2779,18 @@ export namespace dns_v2beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; @@ -2378,6 +2810,7 @@ export namespace dns_v2beta1 { /** * dns.projects.get + * @desc Fetch the representation of an existing Project. * @example * * // BEFORE RUNNING: * // --------------- @@ -2435,8 +2868,8 @@ export namespace dns_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientOperationId - * @param {string} params.project + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.project Identifies the project addressed by 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 @@ -2497,11 +2930,13 @@ export namespace dns_v2beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. */ clientOperationId?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; } @@ -2516,6 +2951,8 @@ export namespace dns_v2beta1 { /** * dns.resourceRecordSets.list + * @desc Enumerate ResourceRecordSets that have been created but not yet + * deleted. * @example * * // BEFORE RUNNING: * // --------------- @@ -2590,12 +3027,12 @@ export namespace dns_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.managedZone - * @param {integer=} params.maxResults - * @param {string=} params.name - * @param {string=} params.pageToken - * @param {string} params.project - * @param {string=} params.type + * @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id. + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.name Restricts the list to return only records with this fully qualified domain name. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {string=} params.type Restricts the list to return only records of this type. If present, the "name" parameter must also be present. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2672,27 +3109,32 @@ export namespace dns_v2beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * Identifies the managed zone addressed by this request. Can be the managed + * zone name or id. */ managedZone?: string; /** - * + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. */ maxResults?: number; /** - * + * Restricts the list to return only records with this fully qualified + * domain name. */ name?: string; /** - * + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. */ pageToken?: string; /** - * + * Identifies the project addressed by this request. */ project?: string; /** - * + * Restricts the list to return only records of this type. If present, the + * "name" parameter must also be present. */ type?: string; } diff --git a/src/apis/docs/v1.ts b/src/apis/docs/v1.ts index 0fea2315a95..fb3a53ed927 100644 --- a/src/apis/docs/v1.ts +++ b/src/apis/docs/v1.ts @@ -2703,11 +2703,12 @@ export namespace docs_v1 { tableCellStyle?: Schema$TableCellStyle; } /** - * A border around a table cell. + * A border around a table cell. Table cell borders cannot be transparent. To + * hide a table cell border, make its width 0. */ export interface Schema$TableCellBorder { /** - * The color of the border. + * The color of the border. This color cannot be transparent. */ color?: Schema$OptionalColor; /** diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index 138bd3f8d05..9547534dbe5 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -87,6 +87,7 @@ export namespace drive_v2 { channels: Resource$Channels; children: Resource$Children; comments: Resource$Comments; + drives: Resource$Drives; files: Resource$Files; parents: Resource$Parents; permissions: Resource$Permissions; @@ -105,6 +106,7 @@ export namespace drive_v2 { this.channels = new Resource$Channels(this.context); this.children = new Resource$Children(this.context); this.comments = new Resource$Comments(this.context); + this.drives = new Resource$Drives(this.context); this.files = new Resource$Files(this.context); this.parents = new Resource$Parents(this.context); this.permissions = new Resource$Permissions(this.context); @@ -129,7 +131,11 @@ export namespace drive_v2 { type?: string; }>; /** - * Whether the user can create Team Drives. + * Whether the user can create shared drives. + */ + canCreateDrives?: boolean; + /** + * Deprecated - use canCreateDrives instead. */ canCreateTeamDrives?: boolean; /** @@ -137,6 +143,11 @@ export namespace drive_v2 { * allowed - allowedWithWarning - incomingOnly - disallowed */ domainSharingPolicy?: string; + /** + * A list of themes that are supported for shared drives. + */ + driveThemes?: + Array<{backgroundImageLink?: string; colorRgb?: string; id?: string;}>; /** * The ETag of the item. */ @@ -227,7 +238,7 @@ export namespace drive_v2 { */ selfLink?: string; /** - * A list of themes that are supported for Team Drives. + * Deprecated - use driveThemes instead. */ teamDriveThemes?: Array<{backgroundImageLink?: string; colorRgb?: string; id?: string;}>; @@ -374,14 +385,28 @@ export namespace drive_v2 { selfLink?: string; } /** - * Representation of a change to a file or Team Drive. + * Representation of a change to a file or shared drive. */ export interface Schema$Change { /** - * Whether the file or Team Drive has been removed from this list of + * The type of the change. Possible values are file and drive. + */ + changeType?: string; + /** + * Whether the file or shared drive has been removed from this list of * changes, for example by deletion or loss of access. */ deleted?: boolean; + /** + * The updated state of the shared drive. Present if the changeType is + * drive, the user is still a member of the shared drive, and the shared + * drive has not been deleted. + */ + drive?: Schema$Drive; + /** + * The ID of the shared drive associated with this change. + */ + driveId?: string; /** * The updated state of the file. Present if the type is file and the file * has not been removed from this list of changes. @@ -408,17 +433,15 @@ export namespace drive_v2 { */ selfLink?: string; /** - * The updated state of the Team Drive. Present if the type is teamDrive, - * the user is still a member of the Team Drive, and the Team Drive has not - * been deleted. + * Deprecated - use drive instead. */ teamDrive?: Schema$TeamDrive; /** - * The ID of the Team Drive associated with this change. + * Deprecated - use driveId instead. */ teamDriveId?: string; /** - * The type of the change. Possible values are file and teamDrive. + * Deprecated - use changeType instead. */ type?: string; } @@ -748,6 +771,116 @@ export namespace drive_v2 { */ selfLink?: string; } + /** + * Representation of a shared drive. + */ + export interface Schema$Drive { + /** + * An image file and cropping parameters from which a background image for + * this shared drive is set. This is a write only field; it can only be set + * on drive.drives.update requests that don't set themeId. When + * specified, all fields of the backgroundImageFile must be set. + */ + backgroundImageFile?: { + id?: string; + width?: number; + xCoordinate?: number; + yCoordinate?: number; + }; + /** + * A short-lived link to this shared drive's background image. + */ + backgroundImageLink?: string; + /** + * Capabilities the current user has on this shared drive. + */ + capabilities?: { + canAddChildren?: boolean; + canChangeCopyRequiresWriterPermissionRestriction?: boolean; + canChangeDomainUsersOnlyRestriction?: boolean; + canChangeDriveBackground?: boolean; + canChangeDriveMembersOnlyRestriction?: boolean; + canComment?: boolean; + canCopy?: boolean; + canDeleteChildren?: boolean; + canDeleteDrive?: boolean; + canDownload?: boolean; + canEdit?: boolean; + canListChildren?: boolean; + canManageMembers?: boolean; + canReadRevisions?: boolean; + canRename?: boolean; + canRenameDrive?: boolean; + canShare?: boolean; + canTrashChildren?: boolean; + }; + /** + * The color of this shared drive as an RGB hex string. It can only be set + * on a drive.drives.update request that does not set themeId. + */ + colorRgb?: string; + /** + * The time at which the shared drive was created (RFC 3339 date-time). + */ + createdDate?: string; + /** + * Whether the shared drive is hidden from default view. + */ + hidden?: boolean; + /** + * The ID of this shared drive which is also the ID of the top level folder + * of this shared drive. + */ + id?: string; + /** + * This is always drive#drive + */ + kind?: string; + /** + * The name of this shared drive. + */ + name?: string; + /** + * A set of restrictions that apply to this shared drive or items inside + * this shared drive. + */ + restrictions?: { + adminManagedRestrictions?: boolean; + copyRequiresWriterPermission?: boolean; + domainUsersOnly?: boolean; + driveMembersOnly?: boolean; + }; + /** + * The ID of the theme from which the background image and color will be + * set. The set of possible driveThemes can be retrieved from a + * drive.about.get response. When not specified on a drive.drives.insert + * request, a random theme is chosen from which the background image and + * color are set. This is a write-only field; it can only be set on requests + * that don't set colorRgb or backgroundImageFile. + */ + themeId?: string; + } + /** + * A list of shared drives. + */ + export interface Schema$DriveList { + /** + * The list of shared drives. If nextPageToken is populated, then this list + * may be incomplete and an additional page of results should be fetched. + */ + items?: Schema$Drive[]; + /** + * This is always drive#driveList + */ + kind?: string; + /** + * The page token for the next page of shared drives. This will be absent if + * the end of the list has been reached. If the token is rejected for any + * reason, it should be discarded, and pagination should be restarted from + * the first page of results. + */ + nextPageToken?: string; + } /** * The metadata for a file. */ @@ -783,12 +916,17 @@ export namespace drive_v2 { canDownload?: boolean; canEdit?: boolean; canListChildren?: boolean; + canMoveChildrenOutOfDrive?: boolean; canMoveChildrenOutOfTeamDrive?: boolean; + canMoveChildrenWithinDrive?: boolean; canMoveChildrenWithinTeamDrive?: boolean; canMoveItemIntoTeamDrive?: boolean; + canMoveItemOutOfDrive?: boolean; canMoveItemOutOfTeamDrive?: boolean; + canMoveItemWithinDrive?: boolean; canMoveItemWithinTeamDrive?: boolean; canMoveTeamDriveItem?: boolean; + canReadDrive?: boolean; canReadRevisions?: boolean; canReadTeamDrive?: boolean; canRemoveChildren?: boolean; @@ -822,10 +960,15 @@ export namespace drive_v2 { description?: string; /** * Short lived download URL for the file. This field is only populated for - * files with content stored in Drive; it is not populated for Google Docs - * or shortcut files. + * files with content stored in Google Drive; it is not populated for Google + * Docs or shortcut files. */ downloadUrl?: string; + /** + * ID of the shared drive the file resides in. Only populated for items in + * shared drives. + */ + driveId?: string; /** * Deprecated: use capabilities/canEdit. */ @@ -850,21 +993,22 @@ export namespace drive_v2 { /** * The final component of fullFileExtension with trailing text that does not * appear to be part of the extension removed. This field is only populated - * for files with content stored in Drive; it is not populated for Google - * Docs or shortcut files. + * for files with content stored in Google Drive; it is not populated for + * Google Docs or shortcut files. */ fileExtension?: string; /** * The size of the file in bytes. This field is only populated for files - * with content stored in Drive; it is not populated for Google Docs or - * shortcut files. + * with content stored in Google Drive; it is not populated for Google Docs + * or shortcut files. */ fileSize?: string; /** * Folder color as an RGB hex string if the file is a folder. The list of * supported colors is available in the folderColorPalette field of the * About resource. If an unsupported color is specified, it will be changed - * to the closest color in the palette. Not populated for Team Drive files. + * to the closest color in the palette. Not populated for items in shared + * drives. */ folderColorRgb?: string; /** @@ -872,13 +1016,13 @@ export namespace drive_v2 { * concatenated extensions, such as "tar.gz". Removing an * extension from the title does not clear this field; however, changing the * extension on the title does update this field. This field is only - * populated for files with content stored in Drive; it is not populated for - * Google Docs or shortcut files. + * populated for files with content stored in Google Drive; it is not + * populated for Google Docs or shortcut files. */ fullFileExtension?: string; /** * Whether any users are granted file access directly on this file. This - * field is only populated for Team Drive files. + * field is only populated for items in shared drives. */ hasAugmentedPermissions?: boolean; /** @@ -889,8 +1033,8 @@ export namespace drive_v2 { hasThumbnail?: boolean; /** * The ID of the file's head revision. This field is only populated for - * files with content stored in Drive; it is not populated for Google Docs - * or shortcut files. + * files with content stored in Google Drive; it is not populated for Google + * Docs or shortcut files. */ headRevisionId?: string; /** @@ -971,8 +1115,8 @@ export namespace drive_v2 { markedViewedByMeDate?: string; /** * An MD5 checksum for the content of this file. This field is only - * populated for files with content stored in Drive; it is not populated for - * Google Docs or shortcut files. + * populated for files with content stored in Google Drive; it is not + * populated for Google Docs or shortcut files. */ md5Checksum?: string; /** @@ -1002,20 +1146,21 @@ export namespace drive_v2 { /** * The original filename of the uploaded content if available, or else the * original value of the title field. This is only available for files with - * binary content in Drive. + * binary content in Google Drive. */ originalFilename?: string; /** - * Whether the file is owned by the current user. Not populated for Team - * Drive files. + * Whether the file is owned by the current user. Not populated for items in + * shared drives. */ ownedByMe?: boolean; /** - * Name(s) of the owner(s) of this file. Not populated for Team Drive files. + * Name(s) of the owner(s) of this file. Not populated for items in shared + * drives. */ ownerNames?: string[]; /** - * The owner(s) of this file. Not populated for Team Drive files. + * The owner(s) of this file. Not populated for items in shared drives. */ owners?: Schema$User[]; /** @@ -1033,7 +1178,7 @@ export namespace drive_v2 { permissionIds?: string[]; /** * The list of permissions for users with access to this file. Not populated - * for Team Drive files. + * for items in shared drives. */ permissions?: Schema$Permission[]; /** @@ -1053,7 +1198,8 @@ export namespace drive_v2 { */ shareable?: boolean; /** - * Whether the file has been shared. Not populated for Team Drive files. + * Whether the file has been shared. Not populated for items in shared + * drives. */ shared?: boolean; /** @@ -1071,12 +1217,12 @@ export namespace drive_v2 { */ spaces?: string[]; /** - * ID of the Team Drive the file resides in. + * Deprecated - use driveId instead. */ teamDriveId?: string; /** - * A thumbnail for the file. This will only be used if Drive cannot generate - * a standard thumbnail. + * A thumbnail for the file. This will only be used if a standard thumbnail + * cannot be generated. */ thumbnail?: {image?: string; mimeType?: string;}; /** @@ -1091,18 +1237,18 @@ export namespace drive_v2 { thumbnailVersion?: string; /** * The title of this file. Note that for immutable items such as the top - * level folders of Team Drives, My Drive root folder, and Application Data - * folder the title is constant. + * level folders of shared drives, My Drive root folder, and Application + * Data folder the title is constant. */ title?: string; /** * The time that the item was trashed (formatted RFC 3339 timestamp). Only - * populated for Team Drive files. + * populated for items in shared drives. */ trashedDate?: string; /** * If the file has been explicitly trashed, the user who trashed it. Only - * populated for Team Drive files. + * populated for items in shared drives. */ trashingUser?: Schema$User; /** @@ -1133,7 +1279,7 @@ export namespace drive_v2 { webViewLink?: string; /** * Whether writers can share the document with other users. Not populated - * for Team Drive files. + * for items in shared drives. */ writersCanShare?: boolean; } @@ -1148,11 +1294,10 @@ export namespace drive_v2 { /** * Whether the search process was incomplete. If true, then some search * results may be missing, since all documents were not searched. This may - * occur when searching multiple Team Drives with the - * "default,allTeamDrives" corpora, but all corpora could not be - * searched. When this happens, it is suggested that clients narrow their - * query by choosing a different corpus such as "default" or - * "teamDrive". + * occur when searching multiple drives with the "allDrives" + * corpora, but all corpora could not be searched. When this happens, it is + * suggested that clients narrow their query by choosing a different corpus + * such as "default" or "drive". */ incompleteSearch?: boolean; /** @@ -1301,6 +1446,18 @@ export namespace drive_v2 { * The name for this permission. */ name?: string; + /** + * Details of whether the permissions on this shared drive item are + * inherited or directly on this item. This is an output-only field which is + * present only for shared drive items. + */ + permissionDetails?: Array<{ + additionalRoles?: string[]; + inherited?: boolean; + inheritedFrom?: string; + permissionType?: string; + role?: string; + }>; /** * A link to the profile photo, if available. */ @@ -1316,9 +1473,7 @@ export namespace drive_v2 { */ selfLink?: string; /** - * Details of whether the permissions on this Team Drive item are inherited - * or directly on this item. This is an output-only field which is present - * only for Team Drive items. + * Deprecated - use permissionDetails instead. */ teamDrivePermissionDetails?: Array<{ additionalRoles?: string[]; @@ -1989,8 +2144,10 @@ export namespace drive_v2 { * * @param {object} params Parameters for request * @param {string} params.changeId The ID of the change. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {string=} params.teamDriveId The Team Drive from which the change will be returned. + * @param {string=} params.driveId The shared drive from which the change will be returned. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2051,8 +2208,10 @@ export namespace drive_v2 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {string=} params.teamDriveId The ID of the Team Drive for which the starting pageToken for listing future changes from that Team Drive will be returned. + * @param {string=} params.driveId The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2115,21 +2274,24 @@ export namespace drive_v2 { /** * drive.changes.list - * @desc Lists the changes for a user or Team Drive. + * @desc Lists the changes for a user or shared drive. * @alias drive.changes.list * @memberOf! () * * @param {object=} params Parameters for request + * @param {string=} params.driveId The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. * @param {boolean=} params.includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. * @param {boolean=} params.includeDeleted Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. + * @param {boolean=} params.includeItemsFromAllDrives Whether both My Drive and shared drive items should be included in results. * @param {boolean=} params.includeSubscribed Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result. - * @param {boolean=} params.includeTeamDriveItems Whether Team Drive files or changes should be included in results. + * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {integer=} params.maxResults Maximum number of changes to return. * @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. * @param {string=} params.spaces A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'. * @param {string=} params.startChangeId Deprecated - use pageToken instead. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {string=} params.teamDriveId The Team Drive from which changes will be returned. If specified the change IDs will be reflective of the Team Drive; use the combined Team Drive ID and change ID as an identifier. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2194,16 +2356,19 @@ export namespace drive_v2 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.driveId The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. * @param {boolean=} params.includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. * @param {boolean=} params.includeDeleted Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. + * @param {boolean=} params.includeItemsFromAllDrives Whether both My Drive and shared drive items should be included in results. * @param {boolean=} params.includeSubscribed Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result. - * @param {boolean=} params.includeTeamDriveItems Whether Team Drive files or changes should be included in results. + * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {integer=} params.maxResults Maximum number of changes to return. * @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. * @param {string=} params.spaces A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'. * @param {string=} params.startChangeId Deprecated - use pageToken instead. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {string=} params.teamDriveId The Team Drive from which changes will be returned. If specified the change IDs will be reflective of the Team Drive; use the combined Team Drive ID and change ID as an identifier. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {().Channel} 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. @@ -2272,11 +2437,20 @@ export namespace drive_v2 { */ changeId?: string; /** - * Whether the requesting application supports Team Drives. + * The shared drive from which the change will be returned. + */ + driveId?: string; + /** + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** - * The Team Drive from which the change will be returned. + * Deprecated use driveId instead. */ teamDriveId?: string; } @@ -2288,12 +2462,21 @@ export namespace drive_v2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Whether the requesting application supports Team Drives. + * The ID of the shared drive for which the starting pageToken for listing + * future changes from that shared drive will be returned. + */ + driveId?: string; + /** + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** - * The ID of the Team Drive for which the starting pageToken for listing - * future changes from that Team Drive will be returned. + * Deprecated use driveId instead. */ teamDriveId?: string; } @@ -2303,6 +2486,12 @@ export namespace drive_v2 { */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** + * The shared drive from which changes will be returned. If specified the + * change IDs will be reflective of the shared drive; use the combined drive + * ID and change ID as an identifier. + */ + driveId?: string; /** * Whether changes should include the file resource if the file is still * accessible by the user at the time of the request, even when a file was @@ -2315,6 +2504,11 @@ export namespace drive_v2 { * the list of changes, for example by deletion or loss of access. */ includeDeleted?: boolean; + /** + * Whether both My Drive and shared drive items should be included in + * results. + */ + includeItemsFromAllDrives?: boolean; /** * Whether to include changes outside the My Drive hierarchy in the result. * When set to false, changes to files such as those in the Application Data @@ -2323,7 +2517,7 @@ export namespace drive_v2 { */ includeSubscribed?: boolean; /** - * Whether Team Drive files or changes should be included in results. + * Deprecated use includeItemsFromAllDrives instead. */ includeTeamDriveItems?: boolean; /** @@ -2346,13 +2540,16 @@ export namespace drive_v2 { */ startChangeId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** - * The Team Drive from which changes will be returned. If specified the - * change IDs will be reflective of the Team Drive; use the combined Team - * Drive ID and change ID as an identifier. + * Deprecated use driveId instead. */ teamDriveId?: string; } @@ -2362,6 +2559,12 @@ export namespace drive_v2 { */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** + * The shared drive from which changes will be returned. If specified the + * change IDs will be reflective of the shared drive; use the combined drive + * ID and change ID as an identifier. + */ + driveId?: string; /** * Whether changes should include the file resource if the file is still * accessible by the user at the time of the request, even when a file was @@ -2374,6 +2577,11 @@ export namespace drive_v2 { * the list of changes, for example by deletion or loss of access. */ includeDeleted?: boolean; + /** + * Whether both My Drive and shared drive items should be included in + * results. + */ + includeItemsFromAllDrives?: boolean; /** * Whether to include changes outside the My Drive hierarchy in the result. * When set to false, changes to files such as those in the Application Data @@ -2382,7 +2590,7 @@ export namespace drive_v2 { */ includeSubscribed?: boolean; /** - * Whether Team Drive files or changes should be included in results. + * Deprecated use includeItemsFromAllDrives instead. */ includeTeamDriveItems?: boolean; /** @@ -2405,13 +2613,16 @@ export namespace drive_v2 { */ startChangeId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** - * The Team Drive from which changes will be returned. If specified the - * change IDs will be reflective of the Team Drive; use the combined Team - * Drive ID and change ID as an identifier. + * Deprecated use driveId instead. */ teamDriveId?: string; @@ -2648,7 +2859,8 @@ export namespace drive_v2 { * * @param {object} params Parameters for request * @param {string} params.folderId The ID of the folder. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {().ChildReference} 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. @@ -2817,7 +3029,12 @@ export namespace drive_v2 { */ folderId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; @@ -3386,7 +3603,7 @@ export namespace drive_v2 { } - export class Resource$Files { + export class Resource$Drives { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -3394,48 +3611,39 @@ export namespace drive_v2 { /** - * drive.files.copy - * @desc Creates a copy of the specified file. - * @alias drive.files.copy + * drive.drives.delete + * @desc Permanently deletes a shared drive for which the user is an + * organizer. The shared drive cannot contain any untrashed items. + * @alias drive.drives.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.convert Whether to convert this file to the corresponding Google Docs format. - * @param {string} params.fileId The ID of the file to copy. - * @param {boolean=} params.ocr Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. - * @param {string=} params.ocrLanguage If ocr is true, hints at the language to use. Valid values are BCP 47 codes. - * @param {boolean=} params.pinned Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {string=} params.timedTextLanguage The language of the timed text. - * @param {string=} params.timedTextTrackName The timed text track name. - * @param {string=} params.visibility The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false. - * @param {().File} params.resource Request body data + * @param {string} params.driveId The ID of the shared drive. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - copy(params?: Params$Resource$Files$Copy, options?: MethodOptions): - GaxiosPromise; - copy( - params: Params$Resource$Files$Copy, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - copy( - params: Params$Resource$Files$Copy, - callback: BodyResponseCallback): void; - copy(callback: BodyResponseCallback): void; - copy( - paramsOrCallback?: Params$Resource$Files$Copy| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Files$Copy; + delete(params?: Params$Resource$Drives$Delete, options?: MethodOptions): + GaxiosPromise; + delete( + params: Params$Resource$Drives$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Drives$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Drives$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Drives$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Files$Copy; + params = {} as Params$Resource$Drives$Delete; options = {}; } @@ -3448,60 +3656,56 @@ export namespace drive_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/drive/v2/files/{fileId}/copy') + url: (rootUrl + '/drive/v2/drives/{driveId}') .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' + method: 'DELETE' }, options), params, - requiredParams: ['fileId'], - pathParams: ['fileId'], + requiredParams: ['driveId'], + pathParams: ['driveId'], context: this.context }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * drive.files.delete - * @desc Permanently deletes a file by ID. Skips the trash. The currently - * authenticated user must own the file or be an organizer on the parent for - * Team Drive files. - * @alias drive.files.delete + * drive.drives.get + * @desc Gets a shared drive's metadata by ID. + * @alias drive.drives.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.fileId The ID of the file to delete. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {string} params.driveId The ID of the shared drive. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete(params?: Params$Resource$Files$Delete, options?: MethodOptions): - GaxiosPromise; - delete( - params: Params$Resource$Files$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Files$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Files$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void|GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Files$Delete; + get(params?: Params$Resource$Drives$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Drives$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Drives$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Drives$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Drives$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Files$Delete; + params = {} as Params$Resource$Drives$Get; options = {}; } @@ -3514,57 +3718,58 @@ export namespace drive_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/drive/v2/files/{fileId}') + url: (rootUrl + '/drive/v2/drives/{driveId}') .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' + method: 'GET' }, options), params, - requiredParams: ['fileId'], - pathParams: ['fileId'], + requiredParams: ['driveId'], + pathParams: ['driveId'], context: this.context }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * drive.files.emptyTrash - * @desc Permanently deletes all of the user's trashed files. - * @alias drive.files.emptyTrash + * drive.drives.hide + * @desc Hides a shared drive from the default view. + * @alias drive.drives.hide * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request + * @param {string} params.driveId The ID of the shared drive. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - emptyTrash( - params?: Params$Resource$Files$Emptytrash, - options?: MethodOptions): GaxiosPromise; - emptyTrash( - params: Params$Resource$Files$Emptytrash, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - emptyTrash( - params: Params$Resource$Files$Emptytrash, - callback: BodyResponseCallback): void; - emptyTrash(callback: BodyResponseCallback): void; - emptyTrash( - paramsOrCallback?: Params$Resource$Files$Emptytrash| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void|GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Files$Emptytrash; + hide(params?: Params$Resource$Drives$Hide, options?: MethodOptions): + GaxiosPromise; + hide( + params: Params$Resource$Drives$Hide, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + hide( + params: Params$Resource$Drives$Hide, + callback: BodyResponseCallback): void; + hide(callback: BodyResponseCallback): void; + hide( + paramsOrCallback?: Params$Resource$Drives$Hide| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Drives$Hide; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Files$Emptytrash; + params = {} as Params$Resource$Drives$Hide; options = {}; } @@ -3577,49 +3782,640 @@ export namespace drive_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/drive/v2/files/trash') + url: (rootUrl + '/drive/v2/drives/{driveId}/hide') .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' + method: 'POST' }, options), params, - requiredParams: [], - pathParams: [], + requiredParams: ['driveId'], + pathParams: ['driveId'], context: this.context }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * drive.files.export - * @desc Exports a Google Doc to the requested MIME type and returns the - * exported content. Please note that the exported content is limited to - * 10MB. - * @alias drive.files.export + * drive.drives.insert + * @desc Creates a new shared drive. + * @alias drive.drives.insert * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.fileId The ID of the file. - * @param {string} params.mimeType The MIME type of the format requested for this export. + * @param {string} params.requestId An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned. + * @param {().Drive} 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$Files$Export, options?: MethodOptions): - GaxiosPromise; - export( - params: Params$Resource$Files$Export, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - export( - params: Params$Resource$Files$Export, - callback: BodyResponseCallback): void; - export(callback: BodyResponseCallback): void; + insert(params?: Params$Resource$Drives$Insert, options?: MethodOptions): + GaxiosPromise; + insert( + params: Params$Resource$Drives$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Drives$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Drives$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Drives$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Drives$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v2/drives').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['requestId'], + pathParams: [], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * drive.drives.list + * @desc Lists the user's shared drives. + * @alias drive.drives.list + * @memberOf! () + * + * @param {object=} params Parameters for request + * @param {integer=} params.maxResults Maximum number of shared drives to return. + * @param {string=} params.pageToken Page token for shared drives. + * @param {string=} params.q Query string for searching shared drives. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Drives$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Drives$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Drives$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Drives$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Drives$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Drives$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v2/drives').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * drive.drives.unhide + * @desc Restores a shared drive to the default view. + * @alias drive.drives.unhide + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.driveId The ID of the shared drive. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + unhide(params?: Params$Resource$Drives$Unhide, options?: MethodOptions): + GaxiosPromise; + unhide( + params: Params$Resource$Drives$Unhide, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + unhide( + params: Params$Resource$Drives$Unhide, + callback: BodyResponseCallback): void; + unhide(callback: BodyResponseCallback): void; + unhide( + paramsOrCallback?: Params$Resource$Drives$Unhide| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Drives$Unhide; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Drives$Unhide; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v2/drives/{driveId}/unhide') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['driveId'], + pathParams: ['driveId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * drive.drives.update + * @desc Updates the metadata for a shared drive. + * @alias drive.drives.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.driveId The ID of the shared drive. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs. + * @param {().Drive} 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$Drives$Update, options?: MethodOptions): + GaxiosPromise; + update( + params: Params$Resource$Drives$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Drives$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Drives$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Drives$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Drives$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v2/drives/{driveId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['driveId'], + pathParams: ['driveId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Drives$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the shared drive. + */ + driveId?: string; + } + export interface Params$Resource$Drives$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the shared drive. + */ + driveId?: string; + /** + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the shared drive belongs. + */ + useDomainAdminAccess?: boolean; + } + export interface Params$Resource$Drives$Hide extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the shared drive. + */ + driveId?: string; + } + export interface Params$Resource$Drives$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * An ID, such as a random UUID, which uniquely identifies this user's + * request for idempotent creation of a shared drive. A repeated request by + * the same user and with the same request ID will avoid creating duplicates + * by attempting to create the same shared drive. If the shared drive + * already exists a 409 error will be returned. + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Drive; + } + export interface Params$Resource$Drives$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Maximum number of shared drives to return. + */ + maxResults?: number; + /** + * Page token for shared drives. + */ + pageToken?: string; + /** + * Query string for searching shared drives. + */ + q?: string; + /** + * Issue the request as a domain administrator; if set to true, then all + * shared drives of the domain in which the requester is an administrator + * are returned. + */ + useDomainAdminAccess?: boolean; + } + export interface Params$Resource$Drives$Unhide extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the shared drive. + */ + driveId?: string; + } + export interface Params$Resource$Drives$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the shared drive. + */ + driveId?: string; + /** + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the shared drive belongs. + */ + useDomainAdminAccess?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Drive; + } + + + export class Resource$Files { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + + /** + * drive.files.copy + * @desc Creates a copy of the specified file. + * @alias drive.files.copy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.convert Whether to convert this file to the corresponding Google Docs format. + * @param {string} params.fileId The ID of the file to copy. + * @param {boolean=} params.ocr Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. + * @param {string=} params.ocrLanguage If ocr is true, hints at the language to use. Valid values are BCP 47 codes. + * @param {boolean=} params.pinned Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {string=} params.timedTextLanguage The language of the timed text. + * @param {string=} params.timedTextTrackName The timed text track name. + * @param {string=} params.visibility The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false. + * @param {().File} 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 + */ + copy(params?: Params$Resource$Files$Copy, options?: MethodOptions): + GaxiosPromise; + copy( + params: Params$Resource$Files$Copy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + copy( + params: Params$Resource$Files$Copy, + callback: BodyResponseCallback): void; + copy(callback: BodyResponseCallback): void; + copy( + paramsOrCallback?: Params$Resource$Files$Copy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Files$Copy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$Copy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v2/files/{fileId}/copy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['fileId'], + pathParams: ['fileId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * drive.files.delete + * @desc Permanently deletes a file by ID. Skips the trash. The currently + * authenticated user must own the file or be an organizer on the parent for + * shared drive files. + * @alias drive.files.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.fileId The ID of the file to delete. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {object} [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$Files$Delete, options?: MethodOptions): + GaxiosPromise; + delete( + params: Params$Resource$Files$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Files$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Files$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Files$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v2/files/{fileId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['fileId'], + pathParams: ['fileId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * drive.files.emptyTrash + * @desc Permanently deletes all of the user's trashed files. + * @alias drive.files.emptyTrash + * @memberOf! () + * + * @param {object=} params Parameters for 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 + */ + emptyTrash( + params?: Params$Resource$Files$Emptytrash, + options?: MethodOptions): GaxiosPromise; + emptyTrash( + params: Params$Resource$Files$Emptytrash, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + emptyTrash( + params: Params$Resource$Files$Emptytrash, + callback: BodyResponseCallback): void; + emptyTrash(callback: BodyResponseCallback): void; + emptyTrash( + paramsOrCallback?: Params$Resource$Files$Emptytrash| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Files$Emptytrash; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$Emptytrash; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v2/files/trash') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * drive.files.export + * @desc Exports a Google Doc to the requested MIME type and returns the + * exported content. Please note that the exported content is limited to + * 10MB. + * @alias drive.files.export + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.fileId The ID of the file. + * @param {string} params.mimeType The MIME type of the format requested for this export. + * @param {object} [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$Files$Export, options?: MethodOptions): + GaxiosPromise; + export( + params: Params$Resource$Files$Export, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + export( + params: Params$Resource$Files$Export, + callback: BodyResponseCallback): void; + export(callback: BodyResponseCallback): void; export( paramsOrCallback?: Params$Resource$Files$Export| BodyResponseCallback, @@ -3741,7 +4537,8 @@ export namespace drive_v2 { * @param {string} params.fileId The ID for the file in question. * @param {string=} params.projection This parameter is deprecated and has no function. * @param {string=} params.revisionId Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.updateViewedDate Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3807,7 +4604,8 @@ export namespace drive_v2 { * @param {boolean=} params.ocr Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. * @param {string=} params.ocrLanguage If ocr is true, hints at the language to use. Valid values are BCP 47 codes. * @param {boolean=} params.pinned Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.timedTextLanguage The language of the timed text. * @param {string=} params.timedTextTrackName The timed text track name. * @param {boolean=} params.useContentAsIndexableText Whether to use the content as indexable text. @@ -3880,17 +4678,20 @@ export namespace drive_v2 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.corpora Comma-separated list of bodies of items (files/documents) to which the query applies. Supported bodies are 'default', 'domain', 'teamDrive' and 'allTeamDrives'. 'allTeamDrives' must be combined with 'default'; all other values must be used in isolation. Prefer 'default' or 'teamDrive' to 'allTeamDrives' for efficiency. + * @param {string=} params.corpora Bodies of items (files/documents) to which the query applies. Supported bodies are 'default', 'domain', 'drive' and 'allDrives'. Prefer 'default' or 'drive' to 'allDrives' for efficiency. * @param {string=} params.corpus The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead. - * @param {boolean=} params.includeTeamDriveItems Whether Team Drive items should be included in results. + * @param {string=} params.driveId ID of the shared drive to search. + * @param {boolean=} params.includeItemsFromAllDrives Whether both My Drive and shared drive items should be included in results. + * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {integer=} params.maxResults The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached. * @param {string=} params.orderBy A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', and 'title_natural'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. * @param {string=} params.pageToken Page token for files. * @param {string=} params.projection This parameter is deprecated and has no function. * @param {string=} params.q Query string for searching files. * @param {string=} params.spaces A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {string=} params.teamDriveId ID of Team Drive to search. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3964,7 +4765,8 @@ export namespace drive_v2 { * @param {boolean=} params.pinned Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. * @param {string=} params.removeParents Comma-separated list of parent IDs to remove. * @param {boolean=} params.setModifiedDate Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.timedTextLanguage The language of the timed text. * @param {string=} params.timedTextTrackName The timed text track name. * @param {boolean=} params.updateViewedDate Whether to update the view date after successfully updating the file. @@ -4034,7 +4836,8 @@ export namespace drive_v2 { * * @param {object} params Parameters for request * @param {string} params.fileId The ID of the file to update. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4094,14 +4897,15 @@ export namespace drive_v2 { /** * drive.files.trash * @desc Moves a file to the trash. The currently authenticated user must - * own the file or be at least a fileOrganizer on the parent for Team Drive - * files. + * own the file or be at least a fileOrganizer on the parent for shared + * drive files. * @alias drive.files.trash * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.fileId The ID of the file to trash. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4166,7 +4970,8 @@ export namespace drive_v2 { * * @param {object} params Parameters for request * @param {string} params.fileId The ID of the file to untrash. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4240,7 +5045,8 @@ export namespace drive_v2 { * @param {boolean=} params.pinned Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. * @param {string=} params.removeParents Comma-separated list of parent IDs to remove. * @param {boolean=} params.setModifiedDate Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.timedTextLanguage The language of the timed text. * @param {string=} params.timedTextTrackName The timed text track name. * @param {boolean=} params.updateViewedDate Whether to update the view date after successfully updating the file. @@ -4318,7 +5124,8 @@ export namespace drive_v2 { * @param {string} params.fileId The ID for the file in question. * @param {string=} params.projection This parameter is deprecated and has no function. * @param {string=} params.revisionId Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.updateViewedDate Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. * @param {().Channel} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4406,7 +5213,12 @@ export namespace drive_v2 { */ pinned?: boolean; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** @@ -4439,7 +5251,12 @@ export namespace drive_v2 { */ fileId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; } @@ -4506,7 +5323,12 @@ export namespace drive_v2 { */ revisionId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** @@ -4540,7 +5362,12 @@ export namespace drive_v2 { */ pinned?: boolean; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** @@ -4588,11 +5415,9 @@ export namespace drive_v2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Comma-separated list of bodies of items (files/documents) to which the - * query applies. Supported bodies are 'default', 'domain', 'teamDrive' and - * 'allTeamDrives'. 'allTeamDrives' must be combined with 'default'; all - * other values must be used in isolation. Prefer 'default' or 'teamDrive' - * to 'allTeamDrives' for efficiency. + * Bodies of items (files/documents) to which the query applies. Supported + * bodies are 'default', 'domain', 'drive' and 'allDrives'. Prefer 'default' + * or 'drive' to 'allDrives' for efficiency. */ corpora?: string; /** @@ -4601,7 +5426,16 @@ export namespace drive_v2 { */ corpus?: string; /** - * Whether Team Drive items should be included in results. + * ID of the shared drive to search. + */ + driveId?: string; + /** + * Whether both My Drive and shared drive items should be included in + * results. + */ + includeItemsFromAllDrives?: boolean; + /** + * Deprecated use includeItemsFromAllDrives instead. */ includeTeamDriveItems?: boolean; /** @@ -4639,11 +5473,16 @@ export namespace drive_v2 { */ spaces?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** - * ID of Team Drive to search. + * Deprecated use driveId instead. */ teamDriveId?: string; } @@ -4707,7 +5546,12 @@ export namespace drive_v2 { */ setModifiedDate?: boolean; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** @@ -4743,7 +5587,12 @@ export namespace drive_v2 { */ fileId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; } @@ -4758,7 +5607,12 @@ export namespace drive_v2 { */ fileId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; } @@ -4773,7 +5627,12 @@ export namespace drive_v2 { */ fileId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; } @@ -4837,7 +5696,12 @@ export namespace drive_v2 { */ setModifiedDate?: boolean; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** @@ -4902,7 +5766,12 @@ export namespace drive_v2 { */ revisionId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** @@ -5060,7 +5929,8 @@ export namespace drive_v2 { * * @param {object} params Parameters for request * @param {string} params.fileId The ID of the file. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {().ParentReference} 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. @@ -5225,7 +6095,12 @@ export namespace drive_v2 { */ fileId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; @@ -5256,15 +6131,16 @@ export namespace drive_v2 { /** * drive.permissions.delete - * @desc Deletes a permission from a file or Team Drive. + * @desc Deletes a permission from a file or shared drive. * @alias drive.permissions.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.fileId The ID for the file or Team Drive. + * @param {string} params.fileId The ID for the file or shared drive. * @param {string} params.permissionId The ID for the permission. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5330,10 +6206,11 @@ export namespace drive_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.fileId The ID for the file or Team Drive. + * @param {string} params.fileId The ID for the file or shared drive. * @param {string} params.permissionId The ID for the permission. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5458,16 +6335,17 @@ export namespace drive_v2 { /** * drive.permissions.insert - * @desc Inserts a permission for a file or Team Drive. + * @desc Inserts a permission for a file or shared drive. * @alias drive.permissions.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.emailMessage A plain text custom message to include in notification emails. - * @param {string} params.fileId The ID for the file or Team Drive. + * @param {string} params.fileId The ID for the file or shared drive. * @param {boolean=} params.sendNotificationEmails Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {().Permission} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5530,16 +6408,17 @@ export namespace drive_v2 { /** * drive.permissions.list - * @desc Lists a file's or Team Drive's permissions. + * @desc Lists a file's or shared drive's permissions. * @alias drive.permissions.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.fileId The ID for the file or Team Drive. - * @param {integer=} params.maxResults The maximum number of permissions to return per page. When not set for files in a Team Drive, at most 100 results will be returned. When not set for files that are not in a Team Drive, the entire list will be returned. + * @param {string} params.fileId The ID for the file or shared drive. + * @param {integer=} params.maxResults The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned. * @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5604,12 +6483,13 @@ export namespace drive_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.fileId The ID for the file or Team Drive. + * @param {string} params.fileId The ID for the file or shared drive. * @param {string} params.permissionId The ID for the permission. * @param {boolean=} params.removeExpiration Whether to remove the expiration date. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.transferOwnership Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'. - * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {().Permission} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5677,12 +6557,13 @@ export namespace drive_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.fileId The ID for the file or Team Drive. + * @param {string} params.fileId The ID for the file or shared drive. * @param {string} params.permissionId The ID for the permission. * @param {boolean=} params.removeExpiration Whether to remove the expiration date. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.transferOwnership Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'. - * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {().Permission} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5752,7 +6633,7 @@ export namespace drive_v2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The ID for the file or Team Drive. + * The ID for the file or shared drive. */ fileId?: string; /** @@ -5760,13 +6641,19 @@ export namespace drive_v2 { */ permissionId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the item belongs. + * requester will be granted access if the file ID parameter refers to a + * shared drive and the requester is an administrator of the domain to which + * the shared drive belongs. */ useDomainAdminAccess?: boolean; } @@ -5777,7 +6664,7 @@ export namespace drive_v2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The ID for the file or Team Drive. + * The ID for the file or shared drive. */ fileId?: string; /** @@ -5785,13 +6672,19 @@ export namespace drive_v2 { */ permissionId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the item belongs. + * requester will be granted access if the file ID parameter refers to a + * shared drive and the requester is an administrator of the domain to which + * the shared drive belongs. */ useDomainAdminAccess?: boolean; } @@ -5819,7 +6712,7 @@ export namespace drive_v2 { */ emailMessage?: string; /** - * The ID for the file or Team Drive. + * The ID for the file or shared drive. */ fileId?: string; /** @@ -5828,13 +6721,19 @@ export namespace drive_v2 { */ sendNotificationEmails?: boolean; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the item belongs. + * requester will be granted access if the file ID parameter refers to a + * shared drive and the requester is an administrator of the domain to which + * the shared drive belongs. */ useDomainAdminAccess?: boolean; @@ -5850,13 +6749,14 @@ export namespace drive_v2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The ID for the file or Team Drive. + * The ID for the file or shared drive. */ fileId?: string; /** * The maximum number of permissions to return per page. When not set for - * files in a Team Drive, at most 100 results will be returned. When not set - * for files that are not in a Team Drive, the entire list will be returned. + * files in a shared drive, at most 100 results will be returned. When not + * set for files that are not in a shared drive, the entire list will be + * returned. */ maxResults?: number; /** @@ -5865,13 +6765,19 @@ export namespace drive_v2 { */ pageToken?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the item belongs. + * requester will be granted access if the file ID parameter refers to a + * shared drive and the requester is an administrator of the domain to which + * the shared drive belongs. */ useDomainAdminAccess?: boolean; } @@ -5883,7 +6789,7 @@ export namespace drive_v2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The ID for the file or Team Drive. + * The ID for the file or shared drive. */ fileId?: string; /** @@ -5895,7 +6801,12 @@ export namespace drive_v2 { */ removeExpiration?: boolean; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** @@ -5905,8 +6816,9 @@ export namespace drive_v2 { transferOwnership?: boolean; /** * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the item belongs. + * requester will be granted access if the file ID parameter refers to a + * shared drive and the requester is an administrator of the domain to which + * the shared drive belongs. */ useDomainAdminAccess?: boolean; @@ -5923,7 +6835,7 @@ export namespace drive_v2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The ID for the file or Team Drive. + * The ID for the file or shared drive. */ fileId?: string; /** @@ -5935,7 +6847,12 @@ export namespace drive_v2 { */ removeExpiration?: boolean; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** @@ -5945,8 +6862,9 @@ export namespace drive_v2 { transferOwnership?: boolean; /** * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the item belongs. + * requester will be granted access if the file ID parameter refers to a + * shared drive and the requester is an administrator of the domain to which + * the shared drive belongs. */ useDomainAdminAccess?: boolean; @@ -7674,8 +8592,7 @@ export namespace drive_v2 { /** * drive.teamdrives.delete - * @desc Permanently deletes a Team Drive for which the user is an - * organizer. The Team Drive cannot contain any untrashed items. + * @desc Deprecated use drives.delete instead. * @alias drive.teamdrives.delete * @memberOf! () * @@ -7739,7 +8656,7 @@ export namespace drive_v2 { /** * drive.teamdrives.get - * @desc Gets a Team Drive's metadata by ID. + * @desc Deprecated use drives.get instead. * @alias drive.teamdrives.get * @memberOf! () * @@ -7802,7 +8719,7 @@ export namespace drive_v2 { /** * drive.teamdrives.insert - * @desc Creates a new Team Drive. + * @desc Deprecated use drives.insert instead. * @alias drive.teamdrives.insert * @memberOf! () * @@ -7869,7 +8786,7 @@ export namespace drive_v2 { /** * drive.teamdrives.list - * @desc Lists the user's Team Drives. + * @desc Deprecated use drives.list instead. * @alias drive.teamdrives.list * @memberOf! () * @@ -7937,7 +8854,7 @@ export namespace drive_v2 { /** * drive.teamdrives.update - * @desc Updates a Team Drive's metadata + * @desc Deprecated use drives.update instead. * @alias drive.teamdrives.update * @memberOf! () * diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index 7bdd916a26b..c5293a8a044 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -85,6 +85,7 @@ export namespace drive_v3 { changes: Resource$Changes; channels: Resource$Channels; comments: Resource$Comments; + drives: Resource$Drives; files: Resource$Files; permissions: Resource$Permissions; replies: Resource$Replies; @@ -98,6 +99,7 @@ export namespace drive_v3 { this.changes = new Resource$Changes(this.context); this.channels = new Resource$Channels(this.context); this.comments = new Resource$Comments(this.context); + this.drives = new Resource$Drives(this.context); this.files = new Resource$Files(this.context); this.permissions = new Resource$Permissions(this.context); this.replies = new Resource$Replies(this.context); @@ -115,9 +117,18 @@ export namespace drive_v3 { */ appInstalled?: boolean; /** - * Whether the user can create Team Drives. + * Whether the user can create shared drives. + */ + canCreateDrives?: boolean; + /** + * Deprecated - use canCreateDrives instead. */ canCreateTeamDrives?: boolean; + /** + * A list of themes that are supported for shared drives. + */ + driveThemes?: + Array<{backgroundImageLink?: string; colorRgb?: string; id?: string;}>; /** * A map of source MIME type to possible targets for all supported exports. */ @@ -154,7 +165,7 @@ export namespace drive_v3 { usageInDriveTrash?: string; }; /** - * A list of themes that are supported for Team Drives. + * Deprecated - use driveThemes instead. */ teamDriveThemes?: Array<{backgroundImageLink?: string; colorRgb?: string; id?: string;}>; @@ -164,9 +175,23 @@ export namespace drive_v3 { user?: Schema$User; } /** - * A change to a file or Team Drive. + * A change to a file or shared drive. */ export interface Schema$Change { + /** + * The type of the change. Possible values are file and drive. + */ + changeType?: string; + /** + * The updated state of the shared drive. Present if the changeType is + * drive, the user is still a member of the shared drive, and the shared + * drive has not been deleted. + */ + drive?: Schema$Drive; + /** + * The ID of the shared drive associated with this change. + */ + driveId?: string; /** * The updated state of the file. Present if the type is file and the file * has not been removed from this list of changes. @@ -182,18 +207,16 @@ export namespace drive_v3 { */ kind?: string; /** - * Whether the file or Team Drive has been removed from this list of + * Whether the file or shared drive has been removed from this list of * changes, for example by deletion or loss of access. */ removed?: boolean; /** - * The updated state of the Team Drive. Present if the type is teamDrive, - * the user is still a member of the Team Drive, and the Team Drive has not - * been removed. + * Deprecated - use drive instead. */ teamDrive?: Schema$TeamDrive; /** - * The ID of the Team Drive associated with this change. + * Deprecated - use driveId instead. */ teamDriveId?: string; /** @@ -201,7 +224,7 @@ export namespace drive_v3 { */ time?: string; /** - * The type of the change. Possible values are file and teamDrive. + * Deprecated - use changeType instead. */ type?: string; } @@ -363,6 +386,118 @@ export namespace drive_v3 { */ nextPageToken?: string; } + /** + * Representation of a shared drive. + */ + export interface Schema$Drive { + /** + * An image file and cropping parameters from which a background image for + * this shared drive is set. This is a write only field; it can only be set + * on drive.drives.update requests that don't set themeId. When + * specified, all fields of the backgroundImageFile must be set. + */ + backgroundImageFile?: { + id?: string; + width?: number; + xCoordinate?: number; + yCoordinate?: number; + }; + /** + * A short-lived link to this shared drive's background image. + */ + backgroundImageLink?: string; + /** + * Capabilities the current user has on this shared drive. + */ + capabilities?: { + canAddChildren?: boolean; + canChangeCopyRequiresWriterPermissionRestriction?: boolean; + canChangeDomainUsersOnlyRestriction?: boolean; + canChangeDriveBackground?: boolean; + canChangeDriveMembersOnlyRestriction?: boolean; + canComment?: boolean; + canCopy?: boolean; + canDeleteChildren?: boolean; + canDeleteDrive?: boolean; + canDownload?: boolean; + canEdit?: boolean; + canListChildren?: boolean; + canManageMembers?: boolean; + canReadRevisions?: boolean; + canRename?: boolean; + canRenameDrive?: boolean; + canShare?: boolean; + canTrashChildren?: boolean; + }; + /** + * The color of this shared drive as an RGB hex string. It can only be set + * on a drive.drives.update request that does not set themeId. + */ + colorRgb?: string; + /** + * The time at which the shared drive was created (RFC 3339 date-time). + */ + createdTime?: string; + /** + * Whether the shared drive is hidden from default view. + */ + hidden?: boolean; + /** + * The ID of this shared drive which is also the ID of the top level folder + * of this shared drive. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "drive#drive". + */ + kind?: string; + /** + * The name of this shared drive. + */ + name?: string; + /** + * A set of restrictions that apply to this shared drive or items inside + * this shared drive. + */ + restrictions?: { + adminManagedRestrictions?: boolean; + copyRequiresWriterPermission?: boolean; + domainUsersOnly?: boolean; + driveMembersOnly?: boolean; + }; + /** + * The ID of the theme from which the background image and color will be + * set. The set of possible driveThemes can be retrieved from a + * drive.about.get response. When not specified on a drive.drives.create + * request, a random theme is chosen from which the background image and + * color are set. This is a write-only field; it can only be set on requests + * that don't set colorRgb or backgroundImageFile. + */ + themeId?: string; + } + /** + * A list of shared drives. + */ + export interface Schema$DriveList { + /** + * The list of shared drives. If nextPageToken is populated, then this list + * may be incomplete and an additional page of results should be fetched. + */ + drives?: Schema$Drive[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "drive#driveList". + */ + kind?: string; + /** + * The page token for the next page of shared drives. This will be absent if + * the end of the list has been reached. If the token is rejected for any + * reason, it should be discarded, and pagination should be restarted from + * the first page of results. + */ + nextPageToken?: string; + } /** * The metadata for a file. */ @@ -388,12 +523,17 @@ export namespace drive_v3 { canDownload?: boolean; canEdit?: boolean; canListChildren?: boolean; + canMoveChildrenOutOfDrive?: boolean; canMoveChildrenOutOfTeamDrive?: boolean; + canMoveChildrenWithinDrive?: boolean; canMoveChildrenWithinTeamDrive?: boolean; canMoveItemIntoTeamDrive?: boolean; + canMoveItemOutOfDrive?: boolean; canMoveItemOutOfTeamDrive?: boolean; + canMoveItemWithinDrive?: boolean; canMoveItemWithinTeamDrive?: boolean; canMoveTeamDriveItem?: boolean; + canReadDrive?: boolean; canReadRevisions?: boolean; canReadTeamDrive?: boolean; canRemoveChildren?: boolean; @@ -424,6 +564,11 @@ export namespace drive_v3 { * A short description of the file. */ description?: string; + /** + * ID of the shared drive the file resides in. Only populated for items in + * shared drives. + */ + driveId?: string; /** * Whether the file has been explicitly trashed, as opposed to recursively * trashed from a parent folder. @@ -435,7 +580,7 @@ export namespace drive_v3 { exportLinks?: {[key: string]: string;}; /** * The final component of fullFileExtension. This is only available for - * files with binary content in Drive. + * files with binary content in Google Drive. */ fileExtension?: string; /** @@ -448,14 +593,14 @@ export namespace drive_v3 { /** * The full file extension extracted from the name field. May contain * multiple concatenated extensions, such as "tar.gz". This is - * only available for files with binary content in Drive. This is + * only available for files with binary content in Google Drive. This is * automatically updated when the name field changes, however it is not * cleared if the new name does not contain a valid extension. */ fullFileExtension?: string; /** * Whether any users are granted file access directly on this file. This - * field is only populated for Team Drive files. + * field is only populated for shared drive files. */ hasAugmentedPermissions?: boolean; /** @@ -466,7 +611,7 @@ export namespace drive_v3 { hasThumbnail?: boolean; /** * The ID of the file's head revision. This is currently only available - * for files with binary content in Drive. + * for files with binary content in Google Drive. */ headRevisionId?: string; /** @@ -518,16 +663,16 @@ export namespace drive_v3 { lastModifyingUser?: Schema$User; /** * The MD5 checksum for the content of the file. This is only applicable to - * files with binary content in Drive. + * files with binary content in Google Drive. */ md5Checksum?: string; /** - * The MIME type of the file. Drive will attempt to automatically detect an - * appropriate value from uploaded content if no value is provided. The - * value cannot be changed unless a new revision is uploaded. If a file is - * created with a Google Doc MIME type, the uploaded content will be - * imported if possible. The supported import formats are published in the - * About resource. + * The MIME type of the file. Google Drive will attempt to automatically + * detect an appropriate value from uploaded content if no value is + * provided. The value cannot be changed unless a new revision is uploaded. + * If a file is created with a Google Doc MIME type, the uploaded content + * will be imported if possible. The supported import formats are published + * in the About resource. */ mimeType?: string; /** @@ -545,24 +690,24 @@ export namespace drive_v3 { modifiedTime?: string; /** * The name of the file. This is not necessarily unique within a folder. - * Note that for immutable items such as the top level folders of Team - * Drives, My Drive root folder, and Application Data folder the name is + * Note that for immutable items such as the top level folders of shared + * drives, My Drive root folder, and Application Data folder the name is * constant. */ name?: string; /** * The original filename of the uploaded content if available, or else the * original value of the name field. This is only available for files with - * binary content in Drive. + * binary content in Google Drive. */ originalFilename?: string; /** - * Whether the user owns the file. Not populated for Team Drive files. + * Whether the user owns the file. Not populated for items in shared drives. */ ownedByMe?: boolean; /** * The owners of the file. Currently, only certain legacy files may have - * more than one owner. Not populated for Team Drive files. + * more than one owner. Not populated for items in shared drives. */ owners?: Schema$User[]; /** @@ -580,7 +725,8 @@ export namespace drive_v3 { permissionIds?: string[]; /** * The full list of permissions for the file. This is only available if the - * requesting user can share the file. Not populated for Team Drive files. + * requesting user can share the file. Not populated for items in shared + * drives. */ permissions?: Schema$Permission[]; /** @@ -594,7 +740,8 @@ export namespace drive_v3 { */ quotaBytesUsed?: string; /** - * Whether the file has been shared. Not populated for Team Drive files. + * Whether the file has been shared. Not populated for items in shared + * drives. */ shared?: boolean; /** @@ -608,7 +755,7 @@ export namespace drive_v3 { sharingUser?: Schema$User; /** * The size of the file's content in bytes. This is only applicable to - * files with binary content in Drive. + * files with binary content in Google Drive. */ size?: string; /** @@ -621,7 +768,7 @@ export namespace drive_v3 { */ starred?: boolean; /** - * ID of the Team Drive the file resides in. + * Deprecated - use driveId instead. */ teamDriveId?: string; /** @@ -642,12 +789,12 @@ export namespace drive_v3 { trashed?: boolean; /** * The time that the item was trashed (RFC 3339 date-time). Only populated - * for Team Drive files. + * for items in shared drives. */ trashedTime?: string; /** * If the file has been explicitly trashed, the user who trashed it. Only - * populated for Team Drive files. + * populated for items in shared drives. */ trashingUser?: Schema$User; /** @@ -676,7 +823,7 @@ export namespace drive_v3 { viewersCanCopyContent?: boolean; /** * A link for downloading the content of the file in a browser. This is only - * available for files with binary content in Drive. + * available for files with binary content in Google Drive. */ webContentLink?: string; /** @@ -686,7 +833,7 @@ export namespace drive_v3 { webViewLink?: string; /** * Whether users with only writer permission can modify the file's - * permissions. Not populated for Team Drive files. + * permissions. Not populated for items in shared drives. */ writersCanShare?: boolean; } @@ -702,11 +849,10 @@ export namespace drive_v3 { /** * Whether the search process was incomplete. If true, then some search * results may be missing, since all documents were not searched. This may - * occur when searching multiple Team Drives with the - * "user,allTeamDrives" corpora, but all corpora could not be - * searched. When this happens, it is suggested that clients narrow their - * query by choosing a different corpus such as "user" or - * "teamDrive". + * occur when searching multiple drives with the "allDrives" + * corpora, but all corpora could not be searched. When this happens, it is + * suggested that clients narrow their query by choosing a different corpus + * such as "user" or "drive". */ incompleteSearch?: boolean; /** @@ -784,6 +930,17 @@ export namespace drive_v3 { * "drive#permission". */ kind?: string; + /** + * Details of whether the permissions on this shared drive item are + * inherited or directly on this item. This is an output-only field which is + * present only for shared drive items. + */ + permissionDetails?: Array<{ + inherited?: boolean; + inheritedFrom?: string; + permissionType?: string; + role?: string; + }>; /** * A link to the user's profile photo, if available. */ @@ -795,9 +952,7 @@ export namespace drive_v3 { */ role?: string; /** - * Details of whether the permissions on this Team Drive item are inherited - * or directly on this item. This is an output-only field which is present - * only for Team Drive items. + * Deprecated - use permissionDetails instead. */ teamDrivePermissionDetails?: Array<{ inherited?: boolean; @@ -1233,8 +1388,10 @@ export namespace drive_v3 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {string=} params.teamDriveId The ID of the Team Drive for which the starting pageToken for listing future changes from that Team Drive will be returned. + * @param {string=} params.driveId The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1297,20 +1454,23 @@ export namespace drive_v3 { /** * drive.changes.list - * @desc Lists the changes for a user or Team Drive. + * @desc Lists the changes for a user or shared drive. * @alias drive.changes.list * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.driveId The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. * @param {boolean=} params.includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. + * @param {boolean=} params.includeItemsFromAllDrives Whether both My Drive and shared drive items should be included in results. * @param {boolean=} params.includeRemoved Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. - * @param {boolean=} params.includeTeamDriveItems Whether Team Drive files or changes should be included in results. + * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {integer=} params.pageSize The maximum number of changes to return per page. * @param {string} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. * @param {boolean=} params.restrictToMyDrive Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive. * @param {string=} params.spaces A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {string=} params.teamDriveId The Team Drive from which changes will be returned. If specified the change IDs will be reflective of the Team Drive; use the combined Team Drive ID and change ID as an identifier. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1375,15 +1535,18 @@ export namespace drive_v3 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.driveId The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. * @param {boolean=} params.includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. + * @param {boolean=} params.includeItemsFromAllDrives Whether both My Drive and shared drive items should be included in results. * @param {boolean=} params.includeRemoved Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. - * @param {boolean=} params.includeTeamDriveItems Whether Team Drive files or changes should be included in results. + * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {integer=} params.pageSize The maximum number of changes to return per page. * @param {string} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. * @param {boolean=} params.restrictToMyDrive Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive. * @param {string=} params.spaces A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {string=} params.teamDriveId The Team Drive from which changes will be returned. If specified the change IDs will be reflective of the Team Drive; use the combined Team Drive ID and change ID as an identifier. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {().Channel} 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. @@ -1449,12 +1612,21 @@ export namespace drive_v3 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Whether the requesting application supports Team Drives. + * The ID of the shared drive for which the starting pageToken for listing + * future changes from that shared drive will be returned. + */ + driveId?: string; + /** + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** - * The ID of the Team Drive for which the starting pageToken for listing - * future changes from that Team Drive will be returned. + * Deprecated use driveId instead. */ teamDriveId?: string; } @@ -1464,6 +1636,12 @@ export namespace drive_v3 { */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** + * The shared drive from which changes will be returned. If specified the + * change IDs will be reflective of the shared drive; use the combined drive + * ID and change ID as an identifier. + */ + driveId?: string; /** * Whether changes should include the file resource if the file is still * accessible by the user at the time of the request, even when a file was @@ -1471,13 +1649,18 @@ export namespace drive_v3 { * entries for this file. */ includeCorpusRemovals?: boolean; + /** + * Whether both My Drive and shared drive items should be included in + * results. + */ + includeItemsFromAllDrives?: boolean; /** * Whether to include changes indicating that items have been removed from * the list of changes, for example by deletion or loss of access. */ includeRemoved?: boolean; /** - * Whether Team Drive files or changes should be included in results. + * Deprecated use includeItemsFromAllDrives instead. */ includeTeamDriveItems?: boolean; /** @@ -1502,13 +1685,16 @@ export namespace drive_v3 { */ spaces?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** - * The Team Drive from which changes will be returned. If specified the - * change IDs will be reflective of the Team Drive; use the combined Team - * Drive ID and change ID as an identifier. + * Deprecated use driveId instead. */ teamDriveId?: string; } @@ -1518,6 +1704,12 @@ export namespace drive_v3 { */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** + * The shared drive from which changes will be returned. If specified the + * change IDs will be reflective of the shared drive; use the combined drive + * ID and change ID as an identifier. + */ + driveId?: string; /** * Whether changes should include the file resource if the file is still * accessible by the user at the time of the request, even when a file was @@ -1525,13 +1717,18 @@ export namespace drive_v3 { * entries for this file. */ includeCorpusRemovals?: boolean; + /** + * Whether both My Drive and shared drive items should be included in + * results. + */ + includeItemsFromAllDrives?: boolean; /** * Whether to include changes indicating that items have been removed from * the list of changes, for example by deletion or loss of access. */ includeRemoved?: boolean; /** - * Whether Team Drive files or changes should be included in results. + * Deprecated use includeItemsFromAllDrives instead. */ includeTeamDriveItems?: boolean; /** @@ -1556,13 +1753,16 @@ export namespace drive_v3 { */ spaces?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** - * The Team Drive from which changes will be returned. If specified the - * change IDs will be reflective of the Team Drive; use the combined Team - * Drive ID and change ID as an identifier. + * Deprecated use driveId instead. */ teamDriveId?: string; @@ -2094,7 +2294,7 @@ export namespace drive_v3 { } - export class Resource$Files { + export class Resource$Drives { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -2102,117 +2302,40 @@ export namespace drive_v3 { /** - * drive.files.copy - * @desc Creates a copy of a file and applies any requested updates with - * patch semantics. - * @alias drive.files.copy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.fileId The ID of the file. - * @param {boolean=} params.ignoreDefaultVisibility Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. - * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive. - * @param {string=} params.ocrLanguage A language hint for OCR processing during image import (ISO 639-1 code). - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {().File} 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 - */ - copy(params?: Params$Resource$Files$Copy, options?: MethodOptions): - GaxiosPromise; - copy( - params: Params$Resource$Files$Copy, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - copy( - params: Params$Resource$Files$Copy, - callback: BodyResponseCallback): void; - copy(callback: BodyResponseCallback): void; - copy( - paramsOrCallback?: Params$Resource$Files$Copy| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Files$Copy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Files$Copy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/drive/v3/files/{fileId}/copy') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['fileId'], - pathParams: ['fileId'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * drive.files.create - * @desc Creates a new file. - * @alias drive.files.create + * drive.drives.create + * @desc Creates a new shared drive. + * @alias drive.drives.create * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.ignoreDefaultVisibility Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. - * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive. - * @param {string=} params.ocrLanguage A language hint for OCR processing during image import (ISO 639-1 code). - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {boolean=} params.useContentAsIndexableText Whether to use the uploaded content as indexable text. - * @param {object} params.resource Media resource metadata - * @param {object} params.media Media object - * @param {string} params.media.mimeType Media mime-type - * @param {string|object} params.media.body Media body contents + * @param {string} params.requestId An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned. + * @param {().Drive} 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$Files$Create, options?: MethodOptions): - GaxiosPromise; + create(params?: Params$Resource$Drives$Create, options?: MethodOptions): + GaxiosPromise; create( - params: Params$Resource$Files$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; + params: Params$Resource$Drives$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; create( - params: Params$Resource$Files$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; + params: Params$Resource$Drives$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( - paramsOrCallback?: Params$Resource$Files$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Files$Create; + paramsOrCallback?: Params$Resource$Drives$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Drives$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Files$Create; + params = {} as Params$Resource$Drives$Create; options = {}; } @@ -2225,62 +2348,57 @@ export namespace drive_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/drive/v3/files').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/drive/v3/drives').replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, options), params, - mediaUrl: - (rootUrl + '/upload/drive/v3/files').replace(/([^:]\/)\/+/g, '$1'), - requiredParams: [], + requiredParams: ['requestId'], pathParams: [], context: this.context }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * drive.files.delete - * @desc Permanently deletes a file owned by the user without moving it to - * the trash. If the file belongs to a Team Drive the user must be an - * organizer on the parent. If the target is a folder, all descendants owned - * by the user are also deleted. - * @alias drive.files.delete + * drive.drives.delete + * @desc Permanently deletes a shared drive for which the user is an + * organizer. The shared drive cannot contain any untrashed items. + * @alias drive.drives.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.fileId The ID of the file. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {string} params.driveId The ID of the shared drive. * @param {object} [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$Files$Delete, options?: MethodOptions): + delete(params?: Params$Resource$Drives$Delete, options?: MethodOptions): GaxiosPromise; delete( - params: Params$Resource$Files$Delete, + params: Params$Resource$Drives$Delete, options: MethodOptions|BodyResponseCallback, callback: BodyResponseCallback): void; delete( - params: Params$Resource$Files$Delete, + params: Params$Resource$Drives$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; delete( - paramsOrCallback?: Params$Resource$Files$Delete| + paramsOrCallback?: Params$Resource$Drives$Delete| BodyResponseCallback, optionsOrCallback?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void|GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Files$Delete; + let params = (paramsOrCallback || {}) as Params$Resource$Drives$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Files$Delete; + params = {} as Params$Resource$Drives$Delete; options = {}; } @@ -2293,14 +2411,14 @@ export namespace drive_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/drive/v3/files/{fileId}') + url: (rootUrl + '/drive/v3/drives/{driveId}') .replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE' }, options), params, - requiredParams: ['fileId'], - pathParams: ['fileId'], + requiredParams: ['driveId'], + pathParams: ['driveId'], context: this.context }; if (callback) { @@ -2312,38 +2430,37 @@ export namespace drive_v3 { /** - * drive.files.emptyTrash - * @desc Permanently deletes all of the user's trashed files. - * @alias drive.files.emptyTrash + * drive.drives.get + * @desc Gets a shared drive's metadata by ID. + * @alias drive.drives.get * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request + * @param {string} params.driveId The ID of the shared drive. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - emptyTrash( - params?: Params$Resource$Files$Emptytrash, - options?: MethodOptions): GaxiosPromise; - emptyTrash( - params: Params$Resource$Files$Emptytrash, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - emptyTrash( - params: Params$Resource$Files$Emptytrash, - callback: BodyResponseCallback): void; - emptyTrash(callback: BodyResponseCallback): void; - emptyTrash( - paramsOrCallback?: Params$Resource$Files$Emptytrash| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void|GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Files$Emptytrash; + get(params?: Params$Resource$Drives$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Drives$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Drives$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Drives$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Drives$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Files$Emptytrash; + params = {} as Params$Resource$Drives$Get; options = {}; } @@ -2356,7 +2473,670 @@ export namespace drive_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/drive/v3/files/trash') + url: (rootUrl + '/drive/v3/drives/{driveId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['driveId'], + pathParams: ['driveId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * drive.drives.hide + * @desc Hides a shared drive from the default view. + * @alias drive.drives.hide + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.driveId The ID of the shared drive. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + hide(params?: Params$Resource$Drives$Hide, options?: MethodOptions): + GaxiosPromise; + hide( + params: Params$Resource$Drives$Hide, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + hide( + params: Params$Resource$Drives$Hide, + callback: BodyResponseCallback): void; + hide(callback: BodyResponseCallback): void; + hide( + paramsOrCallback?: Params$Resource$Drives$Hide| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Drives$Hide; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Drives$Hide; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v3/drives/{driveId}/hide') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['driveId'], + pathParams: ['driveId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * drive.drives.list + * @desc Lists the user's shared drives. + * @alias drive.drives.list + * @memberOf! () + * + * @param {object=} params Parameters for request + * @param {integer=} params.pageSize Maximum number of shared drives to return. + * @param {string=} params.pageToken Page token for shared drives. + * @param {string=} params.q Query string for searching shared drives. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Drives$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Drives$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Drives$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Drives$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Drives$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Drives$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v3/drives').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * drive.drives.unhide + * @desc Restores a shared drive to the default view. + * @alias drive.drives.unhide + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.driveId The ID of the shared drive. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + unhide(params?: Params$Resource$Drives$Unhide, options?: MethodOptions): + GaxiosPromise; + unhide( + params: Params$Resource$Drives$Unhide, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + unhide( + params: Params$Resource$Drives$Unhide, + callback: BodyResponseCallback): void; + unhide(callback: BodyResponseCallback): void; + unhide( + paramsOrCallback?: Params$Resource$Drives$Unhide| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Drives$Unhide; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Drives$Unhide; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v3/drives/{driveId}/unhide') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['driveId'], + pathParams: ['driveId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * drive.drives.update + * @desc Updates the metadate for a shared drive. + * @alias drive.drives.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.driveId The ID of the shared drive. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs. + * @param {().Drive} 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$Drives$Update, options?: MethodOptions): + GaxiosPromise; + update( + params: Params$Resource$Drives$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Drives$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Drives$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Drives$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Drives$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v3/drives/{driveId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['driveId'], + pathParams: ['driveId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Drives$Create extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * An ID, such as a random UUID, which uniquely identifies this user's + * request for idempotent creation of a shared drive. A repeated request by + * the same user and with the same request ID will avoid creating duplicates + * by attempting to create the same shared drive. If the shared drive + * already exists a 409 error will be returned. + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Drive; + } + export interface Params$Resource$Drives$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the shared drive. + */ + driveId?: string; + } + export interface Params$Resource$Drives$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the shared drive. + */ + driveId?: string; + /** + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the shared drive belongs. + */ + useDomainAdminAccess?: boolean; + } + export interface Params$Resource$Drives$Hide extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the shared drive. + */ + driveId?: string; + } + export interface Params$Resource$Drives$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Maximum number of shared drives to return. + */ + pageSize?: number; + /** + * Page token for shared drives. + */ + pageToken?: string; + /** + * Query string for searching shared drives. + */ + q?: string; + /** + * Issue the request as a domain administrator; if set to true, then all + * shared drives of the domain in which the requester is an administrator + * are returned. + */ + useDomainAdminAccess?: boolean; + } + export interface Params$Resource$Drives$Unhide extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the shared drive. + */ + driveId?: string; + } + export interface Params$Resource$Drives$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the shared drive. + */ + driveId?: string; + /** + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the shared drive belongs. + */ + useDomainAdminAccess?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Drive; + } + + + export class Resource$Files { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + + /** + * drive.files.copy + * @desc Creates a copy of a file and applies any requested updates with + * patch semantics. + * @alias drive.files.copy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.fileId The ID of the file. + * @param {boolean=} params.ignoreDefaultVisibility Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. + * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. + * @param {string=} params.ocrLanguage A language hint for OCR processing during image import (ISO 639-1 code). + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {().File} 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 + */ + copy(params?: Params$Resource$Files$Copy, options?: MethodOptions): + GaxiosPromise; + copy( + params: Params$Resource$Files$Copy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + copy( + params: Params$Resource$Files$Copy, + callback: BodyResponseCallback): void; + copy(callback: BodyResponseCallback): void; + copy( + paramsOrCallback?: Params$Resource$Files$Copy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Files$Copy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$Copy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v3/files/{fileId}/copy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['fileId'], + pathParams: ['fileId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * drive.files.create + * @desc Creates a new file. + * @alias drive.files.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.ignoreDefaultVisibility Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. + * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. + * @param {string=} params.ocrLanguage A language hint for OCR processing during image import (ISO 639-1 code). + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {boolean=} params.useContentAsIndexableText Whether to use the uploaded content as indexable text. + * @param {object} params.resource Media resource metadata + * @param {object} params.media Media object + * @param {string} params.media.mimeType Media mime-type + * @param {string|object} params.media.body Media body contents + * @param {object} [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$Files$Create, options?: MethodOptions): + GaxiosPromise; + create( + params: Params$Resource$Files$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Files$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Files$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Files$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v3/files').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + mediaUrl: + (rootUrl + '/upload/drive/v3/files').replace(/([^:]\/)\/+/g, '$1'), + requiredParams: [], + pathParams: [], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * drive.files.delete + * @desc Permanently deletes a file owned by the user without moving it to + * the trash. If the file belongs to a shared drive the user must be an + * organizer on the parent. If the target is a folder, all descendants owned + * by the user are also deleted. + * @alias drive.files.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.fileId The ID of the file. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {object} [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$Files$Delete, options?: MethodOptions): + GaxiosPromise; + delete( + params: Params$Resource$Files$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Files$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Files$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Files$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v3/files/{fileId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['fileId'], + pathParams: ['fileId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * drive.files.emptyTrash + * @desc Permanently deletes all of the user's trashed files. + * @alias drive.files.emptyTrash + * @memberOf! () + * + * @param {object=} params Parameters for 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 + */ + emptyTrash( + params?: Params$Resource$Files$Emptytrash, + options?: MethodOptions): GaxiosPromise; + emptyTrash( + params: Params$Resource$Files$Emptytrash, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + emptyTrash( + params: Params$Resource$Files$Emptytrash, + callback: BodyResponseCallback): void; + emptyTrash(callback: BodyResponseCallback): void; + emptyTrash( + paramsOrCallback?: Params$Resource$Files$Emptytrash| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Files$Emptytrash; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$Emptytrash; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v3/files/trash') .replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE' }, @@ -2518,7 +3298,8 @@ export namespace drive_v3 { * @param {object} params Parameters for request * @param {boolean=} params.acknowledgeAbuse Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. * @param {string} params.fileId The ID of the file. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2579,16 +3360,19 @@ export namespace drive_v3 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.corpora Comma-separated list of bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'teamDrive' and 'allTeamDrives'. 'allTeamDrives' must be combined with 'user'; all other values must be used in isolation. Prefer 'user' or 'teamDrive' to 'allTeamDrives' for efficiency. + * @param {string=} params.corpora Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency. * @param {string=} params.corpus The source of files to list. Deprecated: use 'corpora' instead. - * @param {boolean=} params.includeTeamDriveItems Whether Team Drive items should be included in results. + * @param {string=} params.driveId ID of the shared drive to search. + * @param {boolean=} params.includeItemsFromAllDrives Whether both My Drive and shared drive items should be included in results. + * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {string=} params.orderBy A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. * @param {integer=} params.pageSize The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached. * @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. * @param {string=} params.q A query for filtering the file results. See the "Search for Files" guide for supported syntax. * @param {string=} params.spaces A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {string=} params.teamDriveId ID of Team Drive to search. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {string=} params.teamDriveId Deprecated use driveId instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2653,10 +3437,11 @@ export namespace drive_v3 { * @param {object} params Parameters for request * @param {string=} params.addParents A comma-separated list of parent IDs to add. * @param {string} params.fileId The ID of the file. - * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive. + * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. * @param {string=} params.ocrLanguage A language hint for OCR processing during image import (ISO 639-1 code). * @param {string=} params.removeParents A comma-separated list of parent IDs to remove. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.useContentAsIndexableText Whether to use the uploaded content as indexable text. * @param {object} params.resource Media resource metadata * @param {object} params.media Media object @@ -2729,7 +3514,8 @@ export namespace drive_v3 { * @param {object} params Parameters for request * @param {boolean=} params.acknowledgeAbuse Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. * @param {string} params.fileId The ID of the file. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {().Channel} 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. @@ -2806,7 +3592,7 @@ export namespace drive_v3 { ignoreDefaultVisibility?: boolean; /** * Whether to set the 'keepForever' field in the new head revision. This is - * only applicable to files with binary content in Drive. + * only applicable to files with binary content in Google Drive. */ keepRevisionForever?: boolean; /** @@ -2814,7 +3600,12 @@ export namespace drive_v3 { */ ocrLanguage?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; @@ -2838,7 +3629,7 @@ export namespace drive_v3 { ignoreDefaultVisibility?: boolean; /** * Whether to set the 'keepForever' field in the new head revision. This is - * only applicable to files with binary content in Drive. + * only applicable to files with binary content in Google Drive. */ keepRevisionForever?: boolean; /** @@ -2846,7 +3637,12 @@ export namespace drive_v3 { */ ocrLanguage?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** @@ -2885,7 +3681,12 @@ export namespace drive_v3 { */ fileId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; } @@ -2943,7 +3744,12 @@ export namespace drive_v3 { */ fileId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; } @@ -2954,11 +3760,9 @@ export namespace drive_v3 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Comma-separated list of bodies of items (files/documents) to which the - * query applies. Supported bodies are 'user', 'domain', 'teamDrive' and - * 'allTeamDrives'. 'allTeamDrives' must be combined with 'user'; all other - * values must be used in isolation. Prefer 'user' or 'teamDrive' to - * 'allTeamDrives' for efficiency. + * Bodies of items (files/documents) to which the query applies. Supported + * bodies are 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or + * 'drive' to 'allDrives' for efficiency. */ corpora?: string; /** @@ -2966,7 +3770,16 @@ export namespace drive_v3 { */ corpus?: string; /** - * Whether Team Drive items should be included in results. + * ID of the shared drive to search. + */ + driveId?: string; + /** + * Whether both My Drive and shared drive items should be included in + * results. + */ + includeItemsFromAllDrives?: boolean; + /** + * Deprecated use includeItemsFromAllDrives instead. */ includeTeamDriveItems?: boolean; /** @@ -3002,11 +3815,16 @@ export namespace drive_v3 { */ spaces?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** - * ID of Team Drive to search. + * Deprecated use driveId instead. */ teamDriveId?: string; } @@ -3026,7 +3844,7 @@ export namespace drive_v3 { fileId?: string; /** * Whether to set the 'keepForever' field in the new head revision. This is - * only applicable to files with binary content in Drive. + * only applicable to files with binary content in Google Drive. */ keepRevisionForever?: boolean; /** @@ -3038,7 +3856,12 @@ export namespace drive_v3 { */ removeParents?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** @@ -3082,7 +3905,12 @@ export namespace drive_v3 { */ fileId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; @@ -3102,17 +3930,18 @@ export namespace drive_v3 { /** * drive.permissions.create - * @desc Creates a permission for a file or Team Drive. + * @desc Creates a permission for a file or shared drive. * @alias drive.permissions.create * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.emailMessage A plain text custom message to include in the notification email. - * @param {string} params.fileId The ID of the file or Team Drive. + * @param {string} params.fileId The ID of the file or shared drive. * @param {boolean=} params.sendNotificationEmail Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.transferOwnership Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. - * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {().Permission} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3180,10 +4009,11 @@ export namespace drive_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.fileId The ID of the file or Team Drive. + * @param {string} params.fileId The ID of the file or shared drive. * @param {string} params.permissionId The ID of the permission. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3251,8 +4081,9 @@ export namespace drive_v3 { * @param {object} params Parameters for request * @param {string} params.fileId The ID of the file. * @param {string} params.permissionId The ID of the permission. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3310,16 +4141,17 @@ export namespace drive_v3 { /** * drive.permissions.list - * @desc Lists a file's or Team Drive's permissions. + * @desc Lists a file's or shared drive's permissions. * @alias drive.permissions.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.fileId The ID of the file or Team Drive. - * @param {integer=} params.pageSize The maximum number of permissions to return per page. When not set for files in a Team Drive, at most 100 results will be returned. When not set for files that are not in a Team Drive, the entire list will be returned. + * @param {string} params.fileId The ID of the file or shared drive. + * @param {integer=} params.pageSize The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned. * @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3384,12 +4216,13 @@ export namespace drive_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.fileId The ID of the file or Team Drive. + * @param {string} params.fileId The ID of the file or shared drive. * @param {string} params.permissionId The ID of the permission. * @param {boolean=} params.removeExpiration Whether to remove the expiration date. - * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. + * @param {boolean=} params.supportsAllDrives Whether the requesting application supports both My Drives and shared drives. + * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {boolean=} params.transferOwnership Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. - * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. * @param {().Permission} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3463,7 +4296,7 @@ export namespace drive_v3 { */ emailMessage?: string; /** - * The ID of the file or Team Drive. + * The ID of the file or shared drive. */ fileId?: string; /** @@ -3473,7 +4306,12 @@ export namespace drive_v3 { */ sendNotificationEmail?: boolean; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** @@ -3484,8 +4322,9 @@ export namespace drive_v3 { transferOwnership?: boolean; /** * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the item belongs. + * requester will be granted access if the file ID parameter refers to a + * shared drive and the requester is an administrator of the domain to which + * the shared drive belongs. */ useDomainAdminAccess?: boolean; @@ -3502,7 +4341,7 @@ export namespace drive_v3 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The ID of the file or Team Drive. + * The ID of the file or shared drive. */ fileId?: string; /** @@ -3510,13 +4349,19 @@ export namespace drive_v3 { */ permissionId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the item belongs. + * requester will be granted access if the file ID parameter refers to a + * shared drive and the requester is an administrator of the domain to which + * the shared drive belongs. */ useDomainAdminAccess?: boolean; } @@ -3535,13 +4380,19 @@ export namespace drive_v3 { */ permissionId?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the item belongs. + * requester will be granted access if the file ID parameter refers to a + * shared drive and the requester is an administrator of the domain to which + * the shared drive belongs. */ useDomainAdminAccess?: boolean; } @@ -3552,13 +4403,14 @@ export namespace drive_v3 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The ID of the file or Team Drive. + * The ID of the file or shared drive. */ fileId?: string; /** * The maximum number of permissions to return per page. When not set for - * files in a Team Drive, at most 100 results will be returned. When not set - * for files that are not in a Team Drive, the entire list will be returned. + * files in a shared drive, at most 100 results will be returned. When not + * set for files that are not in a shared drive, the entire list will be + * returned. */ pageSize?: number; /** @@ -3567,13 +4419,19 @@ export namespace drive_v3 { */ pageToken?: string; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the item belongs. + * requester will be granted access if the file ID parameter refers to a + * shared drive and the requester is an administrator of the domain to which + * the shared drive belongs. */ useDomainAdminAccess?: boolean; } @@ -3585,7 +4443,7 @@ export namespace drive_v3 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The ID of the file or Team Drive. + * The ID of the file or shared drive. */ fileId?: string; /** @@ -3597,7 +4455,12 @@ export namespace drive_v3 { */ removeExpiration?: boolean; /** - * Whether the requesting application supports Team Drives. + * Whether the requesting application supports both My Drives and shared + * drives. + */ + supportsAllDrives?: boolean; + /** + * Deprecated use supportsAllDrives instead. */ supportsTeamDrives?: boolean; /** @@ -3608,8 +4471,9 @@ export namespace drive_v3 { transferOwnership?: boolean; /** * Issue the request as a domain administrator; if set to true, then the - * requester will be granted access if they are an administrator of the - * domain to which the item belongs. + * requester will be granted access if the file ID parameter refers to a + * shared drive and the requester is an administrator of the domain to which + * the shared drive belongs. */ useDomainAdminAccess?: boolean; @@ -4094,9 +4958,9 @@ export namespace drive_v3 { /** * drive.revisions.delete * @desc Permanently deletes a file version. You can only delete revisions - * for files with binary content, like images or videos. Revisions for other - * files, like Google Docs or Sheets, and the last remaining file version - * can't be deleted. + * for files with binary content in Google Drive, like images or videos. + * Revisions for other files, like Google Docs or Sheets, and the last + * remaining file version can't be deleted. * @alias drive.revisions.delete * @memberOf! () * @@ -4440,7 +5304,7 @@ export namespace drive_v3 { /** * drive.teamdrives.create - * @desc Creates a new Team Drive. + * @desc Deprecated use drives.create instead. * @alias drive.teamdrives.create * @memberOf! () * @@ -4507,8 +5371,7 @@ export namespace drive_v3 { /** * drive.teamdrives.delete - * @desc Permanently deletes a Team Drive for which the user is an - * organizer. The Team Drive cannot contain any untrashed items. + * @desc Deprecated use drives.delete instead. * @alias drive.teamdrives.delete * @memberOf! () * @@ -4572,7 +5435,7 @@ export namespace drive_v3 { /** * drive.teamdrives.get - * @desc Gets a Team Drive's metadata by ID. + * @desc Deprecated use drives.get instead. * @alias drive.teamdrives.get * @memberOf! () * @@ -4635,7 +5498,7 @@ export namespace drive_v3 { /** * drive.teamdrives.list - * @desc Lists the user's Team Drives. + * @desc Deprecated use drives.list instead. * @alias drive.teamdrives.list * @memberOf! () * @@ -4703,7 +5566,7 @@ export namespace drive_v3 { /** * drive.teamdrives.update - * @desc Updates a Team Drive's metadata + * @desc Deprecated use drives.update instead * @alias drive.teamdrives.update * @memberOf! () * diff --git a/src/apis/driveactivity/v2.ts b/src/apis/driveactivity/v2.ts index cd4d6783718..352a43f258a 100644 --- a/src/apis/driveactivity/v2.ts +++ b/src/apis/driveactivity/v2.ts @@ -341,6 +341,25 @@ export namespace driveactivity_v2 { */ name?: string; } + /** + * Information about a shared drive. + */ + export interface Schema$Drive { + /** + * The resource name of the shared drive. The format is + * "COLLECTION_ID/DRIVE_ID". Clients should not assume a specific + * collection ID for this resource name. + */ + name?: string; + /** + * The root of this shared drive. + */ + root?: Schema$DriveItem; + /** + * The title of the shared drive. + */ + title?: string; + } /** * A single Drive activity comprising one or more Actions by one or more * Actors on one or more Targets. Some Action groupings occur spontaneously, @@ -379,6 +398,19 @@ export namespace driveactivity_v2 { */ timestamp?: string; } + /** + * A Drive item which is a file. + */ + export interface Schema$DriveFile {} + /** + * A Drive item which is a folder. + */ + export interface Schema$DriveFolder { + /** + * The type of Drive folder. + */ + type?: string; + } /** * A Drive item, such as a file or folder. */ @@ -386,10 +418,18 @@ export namespace driveactivity_v2 { /** * The Drive item is a file. */ - file?: Schema$File; + driveFile?: Schema$DriveFile; /** * The Drive item is a folder. */ + driveFolder?: Schema$DriveFolder; + /** + * This field is deprecated; please use the `driveFile` field instead. + */ + file?: Schema$File; + /** + * This field is deprecated; please use the `driveFolder` field instead. + */ folder?: Schema$Folder; /** * The MIME type of the Drive item. See @@ -416,10 +456,18 @@ export namespace driveactivity_v2 { /** * The Drive item is a file. */ - file?: Schema$File; + driveFile?: Schema$DriveFile; /** * The Drive item is a folder. */ + driveFolder?: Schema$DriveFolder; + /** + * This field is deprecated; please use the `driveFile` field instead. + */ + file?: Schema$File; + /** + * This field is deprecated; please use the `driveFolder` field instead. + */ folder?: Schema$Folder; /** * The target Drive item. The format is "items/ITEM_ID". @@ -430,12 +478,27 @@ export namespace driveactivity_v2 { */ title?: string; } + /** + * A lightweight reference to a shared drive. + */ + export interface Schema$DriveReference { + /** + * The resource name of the shared drive. The format is + * "COLLECTION_ID/DRIVE_ID". Clients should not assume a specific + * collection ID for this resource name. + */ + name?: string; + /** + * The title of the shared drive. + */ + title?: string; + } /** * An empty message indicating an object was edited. */ export interface Schema$Edit {} /** - * A Drive item which is a file. + * This item is deprecated; please see `DriveFile` instead. */ export interface Schema$File {} /** @@ -466,11 +529,11 @@ export namespace driveactivity_v2 { parent?: Schema$DriveItem; } /** - * A Drive item which is a folder. + * This item is deprecated; please see `DriveFolder` instead. */ export interface Schema$Folder { /** - * The type of Drive folder. + * This field is deprecated; please see `DriveFolder.type` instead. */ type?: string; } @@ -550,7 +613,11 @@ export namespace driveactivity_v2 { */ domain?: Schema$Domain; /** - * The Team Drive that owns the Drive item. + * The drive that owns the item. + */ + drive?: Schema$DriveReference; + /** + * This field is deprecated; please use the `drive` field instead. */ teamDrive?: Schema$TeamDriveReference; /** @@ -740,6 +807,10 @@ export namespace driveactivity_v2 { * Information about the target of activity. */ export interface Schema$Target { + /** + * The target is a shared drive. + */ + drive?: Schema$Drive; /** * The target is a Drive item. */ @@ -749,7 +820,7 @@ export namespace driveactivity_v2 { */ fileComment?: Schema$FileComment; /** - * The target is a Team Drive. + * This field is deprecated; please use the `drive` field instead. */ teamDrive?: Schema$TeamDrive; } @@ -757,44 +828,46 @@ export namespace driveactivity_v2 { * A lightweight reference to the target of activity. */ export interface Schema$TargetReference { + /** + * The target is a shared drive. + */ + drive?: Schema$DriveReference; /** * The target is a Drive item. */ driveItem?: Schema$DriveItemReference; /** - * The target is a Team Drive. + * This field is deprecated; please use the `drive` field instead. */ teamDrive?: Schema$TeamDriveReference; } /** - * Information about a Team Drive. + * This item is deprecated; please see `Drive` instead. */ export interface Schema$TeamDrive { /** - * The resource name of the Team Drive. The format is - * "teamDrives/TEAM_DRIVE_ID". + * This field is deprecated; please see `Drive.name` instead. */ name?: string; /** - * The root of this Team Drive. + * This field is deprecated; please see `Drive.root` instead. */ root?: Schema$DriveItem; /** - * The title of the Team Drive. + * This field is deprecated; please see `Drive.title` instead. */ title?: string; } /** - * A lightweight reference to a Team Drive. + * This item is deprecated; please see `DriveReference` instead. */ export interface Schema$TeamDriveReference { /** - * The resource name of the Team Drive. The format is - * "teamDrives/TEAM_DRIVE_ID". + * This field is deprecated; please see `DriveReference.name` instead. */ name?: string; /** - * The title of the Team Drive. + * This field is deprecated; please see `DriveReference.title` instead. */ title?: string; } diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index 05372066cfc..4034d066c59 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -133,6 +133,230 @@ 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", + * } ], } ``` + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1Instance { + /** + * Output only. Timestamp when the resource was created. + */ + createTime?: string; + /** + * Optional. Resource labels to represent user provided metadata. Each label + * is a key-value pair, where both the key and the value are arbitrary + * strings provided by the user. + */ + labels?: {[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 + */ + maintenancePolicyNames?: {[key: string]: string;}; + /** + * Unique name of the resource. It uses the form: + * `projects/{project_id}/locations/{location_id}/instances/{instance_id}` + */ + name?: string; + /** + * Output only. Custom string attributes used primarily to expose + * producer-specific information in monitoring dashboards. See + * go/get-instance-metadata. + */ + producerMetadata?: {[key: string]: string;}; + /** + * Output only. The list of data plane resources provisioned for this + * instance, e.g. compute VMs. See go/get-instance-metadata. + */ + provisionedResources?: + Schema$GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource[]; + /** + * The map between RolloutType and the corresponding RolloutMetadata. This + * is only mutated by rollout service. For actuation implementation, this + * information is pass-through for Rollout management. Producer shall not + * modify by itself. For update of a single entry in this map, the update + * field mask shall follow this sementics: go/advanced-field-masks + */ + rolloutMetadata?: { + [key: string]: + Schema$GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata; + }; + /** + * Output only. SLO metadata for instance classification in the Standardized + * dataplane SLO platform. See go/cloud-ssa-standard-slo for feature + * description. + */ + sloMetadata?: + Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata; + /** + * Software versions that are used to deploy this instance. This can be + * mutated by rollout services. + */ + softwareVersions?: {[key: string]: string;}; + /** + * Output only. Current lifecycle state of the resource (e.g. if it's + * being created or ready to use). + */ + state?: string; + /** + * Output only. ID of the associated GCP tenant project. See + * go/get-instance-metadata. + */ + tenantProjectId?: string; + /** + * Output only. Timestamp when the resource was last modified. + */ + updateTime?: string; + } + /** + * NotificationMetadata is the notification state for an instance. + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata { + /** + * Whether the instance update has been rescheduled. + */ + rescheduled?: boolean; + /** + * The scheduled end time for the maintenance window during which update can + * be performed on the instance. + */ + scheduledEndTime?: string; + /** + * The scheduled start time for the maintenance window during which update + * can be performed on the instance. + */ + scheduledStartTime?: string; + /** + * The target release to be applied to the instance. + */ + targetRelease?: string; + } + /** + * Describes provisioned dataplane resources. + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource { + /** + * Type of the resource. This can be either a GCP resource or a custom one + * (e.g. another cloud provider's VM). For GCP compute resources use + * singular form of the names listed in GCP compute API documentation + * (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with + * 'compute-', for example: 'compute-instance', + * 'compute-disk', 'compute-autoscaler'. + */ + resourceType?: string; + /** + * URL identifying the resource, e.g. + * "https://www.googleapis.com/compute/v1/projects/...)". + */ + resourceUrl?: string; + } + /** + * RolloutMetadata for an actuation instance. It maps to a single RolloutType. + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata { + /** + * Instance level notification metadata. + */ + notification?: + Schema$GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata; + /** + * The last Release that has been applied to the instance. + */ + releaseName?: string; + /** + * The last rollout that has been applied to the instance. + */ + rolloutName?: string; + } + /** + * A temporal SLO exclusion specification. + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion { + /** + * Exclusion duration. No restrictions on the possible values. When an + * ongoing operation is taking longer than initially expected, an existing + * entry in the exclusion list can be updated by extending the duration. + * This is supported by the subsystem exporting eligibility data as long as + * such extension is committed at least 10 minutes before the original + * exclusion expiration - otherwise it is possible that there will be + * "gaps" in the exclusion application in the exported timeseries. + */ + exclusionDuration?: string; + /** + * Start time of the exclusion. No alignment (e.g. to a full minute) needed. + */ + exclusionStartTime?: string; + /** + * Human-readable reason for the exclusion. This should be a static string + * (e.g. "Disruptive update in progress") and should not contain + * dynamically generated data (e.g. instance name). Can be left empty. + */ + 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. + */ + sloName?: string; + } + /** + * SloMetadata contains resources required for proper SLO classification of + * the instance. + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata { + /** + * 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[]; + /** + * Name of the SLO tier the Instance belongs to. This name will be expected + * to match the tiers specified in the service SLO configuration. Field is + * mandatory and must not be empty. + */ + tier?: string; + } /** * A Cloud Filestore instance. */ diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index 5d478ef9580..b31bf0f2590 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -133,6 +133,230 @@ 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", + * } ], } ``` + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1Instance { + /** + * Output only. Timestamp when the resource was created. + */ + createTime?: string; + /** + * Optional. Resource labels to represent user provided metadata. Each label + * is a key-value pair, where both the key and the value are arbitrary + * strings provided by the user. + */ + labels?: {[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 + */ + maintenancePolicyNames?: {[key: string]: string;}; + /** + * Unique name of the resource. It uses the form: + * `projects/{project_id}/locations/{location_id}/instances/{instance_id}` + */ + name?: string; + /** + * Output only. Custom string attributes used primarily to expose + * producer-specific information in monitoring dashboards. See + * go/get-instance-metadata. + */ + producerMetadata?: {[key: string]: string;}; + /** + * Output only. The list of data plane resources provisioned for this + * instance, e.g. compute VMs. See go/get-instance-metadata. + */ + provisionedResources?: + Schema$GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource[]; + /** + * The map between RolloutType and the corresponding RolloutMetadata. This + * is only mutated by rollout service. For actuation implementation, this + * information is pass-through for Rollout management. Producer shall not + * modify by itself. For update of a single entry in this map, the update + * field mask shall follow this sementics: go/advanced-field-masks + */ + rolloutMetadata?: { + [key: string]: + Schema$GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata; + }; + /** + * Output only. SLO metadata for instance classification in the Standardized + * dataplane SLO platform. See go/cloud-ssa-standard-slo for feature + * description. + */ + sloMetadata?: + Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata; + /** + * Software versions that are used to deploy this instance. This can be + * mutated by rollout services. + */ + softwareVersions?: {[key: string]: string;}; + /** + * Output only. Current lifecycle state of the resource (e.g. if it's + * being created or ready to use). + */ + state?: string; + /** + * Output only. ID of the associated GCP tenant project. See + * go/get-instance-metadata. + */ + tenantProjectId?: string; + /** + * Output only. Timestamp when the resource was last modified. + */ + updateTime?: string; + } + /** + * NotificationMetadata is the notification state for an instance. + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata { + /** + * Whether the instance update has been rescheduled. + */ + rescheduled?: boolean; + /** + * The scheduled end time for the maintenance window during which update can + * be performed on the instance. + */ + scheduledEndTime?: string; + /** + * The scheduled start time for the maintenance window during which update + * can be performed on the instance. + */ + scheduledStartTime?: string; + /** + * The target release to be applied to the instance. + */ + targetRelease?: string; + } + /** + * Describes provisioned dataplane resources. + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource { + /** + * Type of the resource. This can be either a GCP resource or a custom one + * (e.g. another cloud provider's VM). For GCP compute resources use + * singular form of the names listed in GCP compute API documentation + * (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with + * 'compute-', for example: 'compute-instance', + * 'compute-disk', 'compute-autoscaler'. + */ + resourceType?: string; + /** + * URL identifying the resource, e.g. + * "https://www.googleapis.com/compute/v1/projects/...)". + */ + resourceUrl?: string; + } + /** + * RolloutMetadata for an actuation instance. It maps to a single RolloutType. + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata { + /** + * Instance level notification metadata. + */ + notification?: + Schema$GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata; + /** + * The last Release that has been applied to the instance. + */ + releaseName?: string; + /** + * The last rollout that has been applied to the instance. + */ + rolloutName?: string; + } + /** + * A temporal SLO exclusion specification. + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion { + /** + * Exclusion duration. No restrictions on the possible values. When an + * ongoing operation is taking longer than initially expected, an existing + * entry in the exclusion list can be updated by extending the duration. + * This is supported by the subsystem exporting eligibility data as long as + * such extension is committed at least 10 minutes before the original + * exclusion expiration - otherwise it is possible that there will be + * "gaps" in the exclusion application in the exported timeseries. + */ + exclusionDuration?: string; + /** + * Start time of the exclusion. No alignment (e.g. to a full minute) needed. + */ + exclusionStartTime?: string; + /** + * Human-readable reason for the exclusion. This should be a static string + * (e.g. "Disruptive update in progress") and should not contain + * dynamically generated data (e.g. instance name). Can be left empty. + */ + 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. + */ + sloName?: string; + } + /** + * SloMetadata contains resources required for proper SLO classification of + * the instance. + */ + export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata { + /** + * 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[]; + /** + * Name of the SLO tier the Instance belongs to. This name will be expected + * to match the tiers specified in the service SLO configuration. Field is + * mandatory and must not be empty. + */ + tier?: string; + } /** * A Cloud Filestore instance. */ diff --git a/src/apis/firebasehosting/v1beta1.ts b/src/apis/firebasehosting/v1beta1.ts index b92e219e9ce..ed60ccd5164 100644 --- a/src/apis/firebasehosting/v1beta1.ts +++ b/src/apis/firebasehosting/v1beta1.ts @@ -153,20 +153,20 @@ export namespace firebasehosting_v1beta1 { token?: string; } /** - * A configured rewrite that will direct any requests to a Cloud Run service. - * If the Cloud Run service does not exist when setting or updating your - * Firebase Hosting configuration then the request will fail. Any errors from - * the Cloud Run service (including when the service has been deleted) will be - * passed back down to the end user. + * A configured rewrite that directs requests to a Cloud Run service. If the + * Cloud Run service does not exist when setting or updating your Firebase + * Hosting configuration, then the request fails. Any errors from the Cloud + * Run service are passed to the end user (for example, if you delete a + * service, any requests directed to that service receive a `404` error). */ export interface Schema$CloudRunRewrite { /** - * Optional. The region where the Cloud Run service is hosted. Defaults to - * `us-central1` if not supplied. + * Optional. User-provided region where the Cloud Run service is + * hosted.<br> Defaults to `us-central1` if not supplied. */ region?: string; /** - * Required. User supplied ID of the Cloud Run service. + * Required. User-defined ID of the Cloud Run service. */ serviceId?: string; } diff --git a/src/apis/firebaserules/v1.ts b/src/apis/firebaserules/v1.ts index ddb465ff223..67259472795 100644 --- a/src/apis/firebaserules/v1.ts +++ b/src/apis/firebaserules/v1.ts @@ -432,8 +432,11 @@ export namespace firebaserules_v1 { */ state?: string; /** - * The set of visited expressions for a given test. This returns positions - * and evaluation results of all visited expressions. + * The set of visited permission expressions for a given test. This returns + * the positions and evaluation results of all visited permission + * expressions which were relevant to the test case, e.g. ``` match /path { + * allow read if: <expr> } ``` For a detailed report of the + * intermediate evaluation states, see the `expression_reports` field */ visitedExpressions?: Schema$VisitedExpression[]; } diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index 6b0fb82109d..056e0f6ae91 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -1530,7 +1530,7 @@ export namespace firestore_v1 { */ delete?: string; /** - * Applies a tranformation to a document. At most one `transform` per + * Applies a transformation to a document. At most one `transform` per * document is allowed in a given request. An `update` cannot follow a * `transform` on the same document in a given request. */ diff --git a/src/apis/firestore/v1beta1.ts b/src/apis/firestore/v1beta1.ts index 1fff8d98b8f..a2d45c502c4 100644 --- a/src/apis/firestore/v1beta1.ts +++ b/src/apis/firestore/v1beta1.ts @@ -1321,7 +1321,7 @@ export namespace firestore_v1beta1 { */ delete?: string; /** - * Applies a tranformation to a document. At most one `transform` per + * Applies a transformation to a document. At most one `transform` per * document is allowed in a given request. An `update` cannot follow a * `transform` on the same document in a given request. */ diff --git a/src/apis/fitness/v1.ts b/src/apis/fitness/v1.ts index a7d1b091213..1ba56e4f48d 100644 --- a/src/apis/fitness/v1.ts +++ b/src/apis/fitness/v1.ts @@ -401,7 +401,7 @@ export namespace fitness_v1 { * The exact format of the data stream ID created by a REST client is: * type:dataType.name:developer project * number:device.manufacturer:device.model:device.uid:dataStreamName When - * any of the optional fields that comprise of the data stream ID are blank, + * any of the optional fields that make up the data stream ID are absent, * they will be omitted from the data stream ID. The minimum viable data * stream ID would be: type:dataType.name:developer project number Finally, * the developer project number is obfuscated when read by any REST or diff --git a/src/apis/healthcare/v1alpha.ts b/src/apis/healthcare/v1alpha.ts index 87eddb11196..09d8694b6fd 100644 --- a/src/apis/healthcare/v1alpha.ts +++ b/src/apis/healthcare/v1alpha.ts @@ -106,63 +106,6 @@ export namespace healthcare_v1alpha { } } - /** - * An annotation record. - */ - export interface Schema$Annotation { - /** - * Details of the source. - */ - annotationSource?: Schema$AnnotationSource; - /** - * Annnotations for images, e.g., bounding polygons. - */ - imageAnnotation?: Schema$ImageAnnotation; - /** - * Output only. Resource name of the Annotation, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. - */ - name?: string; - /** - * Annotations for resource, e.g., classification tags. - */ - resourceAnnotation?: Schema$ResourceAnnotation; - /** - * Annotations for sentitive texts, e.g., range of such texts. - */ - textAnnotation?: Schema$SensitiveTextAnnotation; - } - /** - * AnnotationSource holds the source information of the annotation. - */ - export interface Schema$AnnotationSource { - /** - * Cloud Healthcare API resource. - */ - cloudHealthcareSource?: Schema$CloudHealthcareSource; - } - /** - * An Annotation store that can store annotation resources such as labels and - * tags for text, image and audio. - */ - export interface Schema$AnnotationStore { - /** - * User-supplied key-value pairs used to organize Annotation stores. Label - * keys must be between 1 and 63 characters long, have a UTF-8 encoding of - * maximum 128 bytes, and must conform to the following PCRE regular - * expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be - * between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 - * bytes, and must conform to the following PCRE regular expression: - * [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated - * with a given store. - */ - labels?: {[key: string]: string;}; - /** - * Output only. Resource name of the Annotation store, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. - */ - name?: string; - } /** * Specifies the audit configuration for a service. The configuration * determines which permission types are logged, and what identities, if any, @@ -218,53 +161,12 @@ export namespace healthcare_v1alpha { */ logType?: string; } - /** - * The BigQuery table to which the output should be written. - */ - export interface Schema$BigQueryDestination { - /** - * Required. The BigQuery dataset to which the DICOM store should be - * exported. If this dataset does not exist, the export call returns an - * error. - */ - dataset?: string; - /** - * If the destination table already exists and this flag is `TRUE`, the - * table will be overwritten by the contents of the DICOM store. If the flag - * is not set and the destination table already exists, the export call - * returns an error. - */ - overwriteTable?: boolean; - /** - * Required. The BigQuery table to which the DICOM store should be written. - * If this table does not exist, a new table with the given name will be - * created. - */ - table?: string; - } - /** - * BigQuery dataset location. - */ - export interface Schema$BigQueryLocation { - /** - * ID of the dataset that houses the BigQuery tables. - */ - datasetId?: string; - /** - * ID of the project that owns the BigQuery datasets. - */ - projectId?: string; - /** - * The configuration for the exported BigQuery schema. - */ - schemaConfig?: Schema$SchemaConfig; - } /** * Associates `members` with a `role`. */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ @@ -291,158 +193,6 @@ export namespace healthcare_v1alpha { */ role?: string; } - /** - * A bounding polygon for the detected image annotation. - */ - export interface Schema$BoundingPoly { - label?: string; - vertices?: Schema$Vertex[]; - } - /** - * Cloud Healthcare API resource. - */ - export interface Schema$CloudHealthcareSource { - /** - * Full path of a Cloud Healthcare API resource. - */ - name?: string; - } - /** - * Creates a new message. - */ - export interface Schema$CreateMessageRequest { - /** - * HL7v2 message. - */ - message?: Schema$Message; - } - /** - * A message representing a health dataset. A health dataset represents a - * collection of healthcare data pertaining to one or more patients. This may - * include multiple modalities of healthcare data, such as electronic medical - * records or medical imaging data. - */ - export interface Schema$Dataset { - /** - * Output only. Resource name of the dataset, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. - */ - name?: string; - /** - * The default timezone used by this dataset. Must be a either a valid IANA - * time zone name such as "America/New_York" or empty, which - * defaults to UTC. This is used for parsing times in resources (e.g., HL7 - * messages) where no explicit timezone is specified. - */ - timeZone?: string; - } - /** - * Configures de-id options specific to different types of content. Each - * submessage customizes the handling of an - * https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are - * applied in a nested manner at runtime. - */ - export interface Schema$DeidentifyConfig { - /** - * Configures de-id of application/DICOM content. - */ - dicom?: Schema$DicomConfig; - /** - * Configures de-id of application/FHIR content. - */ - fhir?: Schema$FhirConfig; - /** - * Configures de-identification of image pixels wherever they are found in - * the source_dataset. - */ - image?: Schema$ImageConfig; - } - /** - * Redacts identifying information from the specified dataset. - */ - export interface Schema$DeidentifyDatasetRequest { - /** - * Deidentify configuration - */ - config?: Schema$DeidentifyConfig; - /** - * The name of the dataset resource to which the redacted data should be - * written (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). - * The new dataset must not exist, or the request will fail. - */ - destinationDataset?: string; - } - /** - * Contains multiple sensitive information findings for each resource slice. - */ - export interface Schema$Detail { - findings?: Schema$Finding[]; - } - /** - * Specifies the parameters needed for de-identification of DICOM stores. - */ - export interface Schema$DicomConfig { - /** - * Tags to be whitelisted, for example "PatientID", - * "0010,0010". Any tag that is whitelisted will copied as is. All - * other tags will be omitted. - */ - whitelistTags?: string[]; - } - /** - * Represents a DICOM store. - */ - export interface Schema$DicomStore { - /** - * 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?: string; - /** - * Notification destination for new DICOM instances. Supplied by the client. - */ - notificationConfig?: Schema$NotificationConfig; - } - /** - * 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 {} - /** - * Exports data from the specified DICOM store. If a given resource (e.g., a - * DICOM object with the same SOPInstance UID) already exists in the output, - * it is overwritten with the version in the source dataset. Exported DICOM - * data will persist when the DICOM store from which it was exported is - * deleted. - */ - export interface Schema$ExportDicomDataRequest { - /** - * Specifies where the exported data should be placed. - */ - outputConfig?: Schema$OutputConfig; - } - /** - * Request to export resources. - */ - export interface Schema$ExportResourcesRequest { - /** - * The BigQuery destination location. The output will be one BigQuery table - * per resource type. - */ - bigqueryDestinationLocation?: Schema$BigQueryLocation; - /** - * The Cloud Storage destination location. Specify a path to a Cloud Storage - * bucket or folder rather than a concrete object. The exported outputs are - * organized by FHIR resource types. The server will create one object per - * resource type. Each object contains newline delimited JSON, and each line - * is a FHIR resource. - */ - gcsDestinationLocation?: Schema$GcsDataLocation; - } /** * Represents an expression text. Example: title: "User account * presence" description: "Determines whether the request has a @@ -473,7177 +223,293 @@ export namespace healthcare_v1alpha { title?: string; } /** - * Specifies how de-identification of a FHIR store should be handled. - */ - export interface Schema$FhirConfig {} - /** - * Represents a FHIR store. + * The response message for Locations.ListLocations. */ - export interface Schema$FhirStore { - /** - * Whether to disable referential integrity in this FHIR store. This field - * is immutable after FHIR store creation. The default value is false, - * meaning that the API will enforce referential integrity and fail the - * requests that will result in inconsistent state in the FHIR store. When - * this field is set to true, the API will skip referential integrity check. - * Consequently, operations that rely on references, such as - * GetPatientEverything, will not return all the results if broken - * references exist. - */ - disableReferentialIntegrity?: boolean; - /** - * Whether to disable resource versioning for this FHIR store. This field - * can not be changed after the creation of FHIR store. If set to false, - * which is the default behavior, all write operations will cause historical - * versions to be recorded automatically. The historical versions can be - * fetched through the history APIs, but cannot be updated. If set to true, - * no historical versions will be kept. The server will send back errors for - * attempts to read the historical versions. - */ - disableResourceVersioning?: boolean; - /** - * Whether this FHIR store has the [updateCreate - * capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). - * This determines if the client can use an Update operation to create a new - * resource with a client-specified ID. If false, all IDs are - * server-assigned through the Create operation and attempts to Update a - * non-existent resource will return errors. Please treat the audit logs - * with appropriate levels of care if client-specified resource IDs contain - * sensitive data such as patient identifiers, those IDs will be part of the - * FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub - * notifications. - */ - enableUpdateCreate?: boolean; - /** - * Output only. Resource name of the FHIR store, of the form - * `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - */ - name?: string; - /** - * 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; - } - export interface Schema$Finding { - /** - * Zero-based ending index of the found text, exclusively. - */ - end?: string; - /** - * The type of information stored in this text range (e.g. HumanName, - * BirthDate, Address, etc.) - */ - infoType?: string; + export interface Schema$ListLocationsResponse { /** - * Zero-based starting index of the found text, inclusively. + * A list of locations that matches the specified filter in the request. */ - start?: string; - } - /** - * Google Cloud Storage location. - */ - export interface Schema$GcsDataLocation { + locations?: Schema$Location[]; /** - * The gcs_uri must be in the format "gs://bucket/path/to/object". - * The gcs_uri may include wildcards in the "path/to/object" part - * to to indicate potential matching of multiple objects. Supported - * wildcards: '*' to match 0 or more non-separator characters - * '**' to match 0 or more characters (including separators). Only - * supported at the end of a path and with no other wildcards. '?' - * to match 1 character. + * The standard List next-page token. */ - gcsUri?: string; + nextPageToken?: string; } /** - * The Google Cloud Storage location to which the output should be written. + * The response message for Operations.ListOperations. */ - export interface Schema$GcsDestination { + export interface Schema$ListOperationsResponse { /** - * MIME types supported by DICOM spec. Each file will be written in the - * following format: - * `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}` - * The frame_number component will exist only for multi-frame instances. - * Refer to the DICOM conformance statement for permissible MIME types: - * https://cloud.google.com/healthcare/docs/dicom#wado-rs The following - * extensions will be used for output files: application/dicom -> .dcm - * image/jpeg -> .jpg image/png -> .png If unspecified, the - * instances will be exported in their original DICOM format. + * The standard List next-page token. */ - mimeType?: string; + nextPageToken?: string; /** - * URI for a Google Cloud Storage directory to which result files should be - * written (e.g., `gs://bucket-id/path/to/destination/dir`). If there is no - * trailing slash, the service will append one when composing the object - * path. The user is responsible for creating the Google Cloud Storage - * bucket referenced in `uri_prefix`. + * A list of operations that matches the specified filter in the request. */ - uriPrefix?: string; + operations?: Schema$Operation[]; } /** - * Request message for `GetIamPolicy` method. - */ - export interface Schema$GetIamPolicyRequest {} - /** - * Final response of exporting resources. This structure will be included in - * the response to describe the detailed outcome. It will only be included - * when the operation finishes. + * A resource that represents Google Cloud Platform location. */ - export interface Schema$GoogleCloudHealthcareV1alphaFhirRestExportResourcesResponse { + export interface Schema$Location { /** - * The FHIR store name of the resources that have been exported, in the - * format - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * The friendly name for this location, typically a nearby city name. For + * example, "Tokyo". */ - name?: string; + displayName?: string; /** - * The total number of resources exported from the requested FHIR store. + * Cross-service attributes for the location. For example + * {"cloud.googleapis.com/region": "us-east1"} */ - resourceCount?: string; - } - /** - * Final response of importing resources. This structure will be included in - * the response to describe the detailed outcome. It will only be included - * when the operation finishes. - */ - export interface Schema$GoogleCloudHealthcareV1alphaFhirRestImportResourcesResponse { + labels?: {[key: string]: string;}; /** - * The number of resources that had errors. + * The canonical id for this location. For example: `"us-east1"`. */ - errorCount?: string; + locationId?: string; /** - * The total number of resources included in the source data. This is the - * sum of the success and error counts. + * Service-specific metadata. For example the available capacity at the + * given location. */ - inputSize?: string; + metadata?: {[key: string]: any;}; /** - * The FHIR store name the resources have been imported to, in the format - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * Resource name for the location, which may vary between implementations. + * For example: `"projects/example-project/locations/us-east1"` */ name?: string; - /** - * The number of resources that have been imported. - */ - successCount?: string; } /** - * The Google Cloud Storage location for the input content. + * This resource represents a long-running operation that is the result of a + * network API call. */ - export interface Schema$GoogleCloudHealthcareV1alphaGcsSource { + 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; /** - * Points to a [Google Cloud Storage](https://cloud.google.com/storage/) URI - * containing file(s) with content only. The URI must be in the following - * format: `gs://bucket-id/object-id`. The URI can include wildcards in - * `object-id` and thus identify multiple files. Supported wildcards: - * '*' to match 0 or more non-separator characters '**' to - * match 0 or more characters (including separators). Must be used at the - * end of a path and with no other wildcards in the path. Can also be - * used with a file extension (such as .dcm), which imports all files - * with the extension in the specified directory and its - * sub-directories. For example, `gs://bucket-id/directory-id/**.dcm` - * imports all files with .dcm extensions in `directory-id/` and its - * sub-directories. '?' to match 1 character Returns - * [google.rpc.Code.INVALID_ARGUMENT] for all other URI formats. Files - * matching the wildcard are expected to contain content only, no metadata. + * The error result of the operation in case of failure or cancellation. */ - contentUri?: string; - } - /** - * Represents an HL7v2 store. - */ - export interface Schema$Hl7V2Store { + error?: Schema$Status; /** - * Output only. Resource name of the HL7v2 store, of the form - * `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + * 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. */ - name?: string; + metadata?: {[key: string]: any;}; /** - * The notification destination all messages (both Ingest & Create) are - * published on. Only the message name is sent as part of the notification. - * If this is unset, no notifications will be sent. Supplied by the client. + * 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`. */ - notificationConfig?: Schema$NotificationConfig; + name?: string; /** - * The configuration for the parser. It determines how the server parses the - * messages. + * 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`. */ - parserConfig?: Schema$ParserConfig; + response?: {[key: string]: any;}; } /** - * Message that represents an arbitrary HTTP body. It should only be used for - * payload formats that can't be represented as JSON, such as raw binary - * or an HTML page. This message can be used both in streaming and - * non-streaming API methods in the request as well as the response. It can - * be used as a top-level request field, which is convenient if one wants to - * extract parameters from either the URL or HTTP template into the request - * fields and also want access to the raw HTTP body. Example: message - * GetResourceRequest { // A unique request id. string request_id - * = 1; // The raw HTTP body is bound to this field. - * google.api.HttpBody http_body = 2; } service ResourceService { rpc - * GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - * UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - * Example with streaming methods: service CaldavService { rpc - * GetCalendar(stream google.api.HttpBody) returns (stream - * google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - * returns (stream google.api.HttpBody); } Use of this type only changes - * how the request and response bodies are handled, all other features will - * continue to work unchanged. + * Defines an Identity and Access Management (IAM) policy. It is used to + * specify access control policies for Cloud Platform resources. A `Policy` + * consists of a list of `bindings`. A `binding` binds a list of `members` to + * a `role`, where the members can be user accounts, Google groups, Google + * domains, and service accounts. A `role` is a named list of permissions + * defined by IAM. **JSON Example** { "bindings": [ { + * "role": "roles/owner", "members": [ + * "user:mike@example.com", "group:admins@example.com", + * "domain:google.com", + * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { + * "role": "roles/viewer", "members": + * ["user:sean@example.com"] } ] } **YAML + * Example** bindings: - members: - user:mike@example.com - + * group:admins@example.com - domain:google.com - + * serviceAccount:my-other-app@appspot.gserviceaccount.com role: + * roles/owner - members: - user:sean@example.com role: + * roles/viewer For a description of IAM and its features, see the [IAM + * developer's guide](https://cloud.google.com/iam/docs). */ - export interface Schema$HttpBody { + export interface Schema$Policy { /** - * The HTTP Content-Type header value specifying the content type of the - * body. + * Specifies cloud audit logging configuration for this policy. */ - contentType?: string; + auditConfigs?: Schema$AuditConfig[]; /** - * The HTTP request/response body as raw binary. + * Associates a list of `members` to a `role`. `bindings` with no members + * will result in an error. */ - data?: string; + bindings?: Schema$Binding[]; /** - * Application specific response metadata. Must be set in the first response - * for streaming APIs. + * `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. */ - extensions?: Array<{[key: string]: any;}>; - } - /** - * Image annotation. - */ - export interface Schema$ImageAnnotation { + etag?: string; /** - * The list of polygons outlining the sensitive regions in the image. + * Deprecated. */ - boundingPolys?: Schema$BoundingPoly[]; + version?: number; } /** - * Specifies how de-identification of image pixel should be handled. + * Request message for `SetIamPolicy` method. */ - export interface Schema$ImageConfig { + export interface Schema$SetIamPolicyRequest { /** - * If true, all text found in the image is redacted. + * REQUIRED: The complete policy to be applied to the `resource`. The size + * of the policy is limited to a few 10s of KB. An empty policy is a valid + * policy but certain Cloud Platform services (such as Projects) might + * reject them. */ - redactAllText?: boolean; - } - /** - * Returns the errors encountered during DICOM store import. - */ - export interface Schema$ImportDicomDataErrorDetails { + policy?: Schema$Policy; /** - * Contains errors encountered in imports of individual resources (e.g., a - * Google Cloud Storage object). + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. + * Only the fields in the mask will be modified. If no mask is provided, the + * following default mask is used: paths: "bindings, etag" This + * field is only used by Cloud IAM. */ - errors?: Schema$ImportError[]; + updateMask?: string; } /** - * Imports data into the specified DICOM store. Returns an error if any of the - * files to import are not DICOM files. This API will accept duplicate DICOM - * instances, by simply ignoring the newly pushed instance (it will not - * overwrite). - */ - export interface Schema$ImportDicomDataRequest { - /** - * Specifies where the imported data resides. - */ - inputConfig?: Schema$InputConfig; - } - /** - * Contains error status for each import failure. - */ - export interface Schema$ImportError { - /** - * Resource name. - */ - resource?: string; - /** - * Error status associated with resource. - */ - status?: Schema$Status; - } - /** - * Request to import resources. The FHIR resources to be imported must have - * client supplied IDs. The server will retain the resource IDs. The import - * operation is idempotent. Retry will overwrite existing data identified by - * client supplied IDs. The import operation is not transactional. The server - * will not roll back any committed changes upon partial failures. - */ - export interface Schema$ImportResourcesRequest { - /** - * The content structure in the source location. The default is BUNDLE. - */ - contentStructure?: string; - /** - * The Cloud Storage bucket/folder path to write files that contain error - * details. - */ - gcsErrorLocation?: Schema$GcsDataLocation; - /** - * Cloud Storage source data locations. Each Cloud Storage object should be - * a text file that contains newline delimited JSON structures conforming to - * FHIR standard. - */ - gcsSourceLocation?: Schema$GcsDataLocation; - } - /** - * Ingests a message into the specified HL7v2 store. - */ - export interface Schema$IngestMessageRequest { - /** - * HL7v2 message to ingest. - */ - message?: Schema$Message; - } - /** - * Acknowledges that a message has been ingested into the specified HL7v2 - * store. - */ - export interface Schema$IngestMessageResponse { - /** - * HL7v2 ACK message. - */ - hl7Ack?: string; - /** - * Created message resource. - */ - message?: Schema$Message; - } - /** - * Specifies the location(s) from which data should be imported. - */ - export interface Schema$InputConfig { - /** - * Files on Google Cloud Storage. To enable the Cloud Healthcare API to read - * from resources in your project (e.g. Google Cloud Storage buckets), you - * must give the consumer Cloud Healthcare API service account the proper - * permissions. The service account is: - * `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The - * PROJECT_NUMBER identifies the project that contains the source Google - * Cloud Storage bucket. To get the project number, go to the GCP Console - * Dashboard. GcsSource requires the `roles/storage.objectViewer` Cloud IAM - * role. - */ - gcsSource?: Schema$GoogleCloudHealthcareV1alphaGcsSource; - } - /** - * Lists the Annotations in the specified Annotation store. - */ - export interface Schema$ListAnnotationsResponse { - /** - * The returned Annotations names. Won't be more values than the value - * of page_size in the request. - */ - annotations?: string[]; - /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. - */ - nextPageToken?: string; - } - /** - * Lists the Annotation stores in the given dataset. - */ - export interface Schema$ListAnnotationStoresResponse { - /** - * The returned Annotation stores. Won't be more Annotation stores than - * the value of page_size in the request. - */ - annotationStores?: Schema$AnnotationStore[]; - /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. - */ - nextPageToken?: string; - } - /** - * Lists the available datasets. - */ - export interface Schema$ListDatasetsResponse { - /** - * The first page of datasets. - */ - datasets?: Schema$Dataset[]; - /** - * Token to retrieve the next page of results, or empty if there are no more - * results in the list. - */ - nextPageToken?: string; - } - /** - * Lists the DICOM stores in the given dataset. - */ - export interface Schema$ListDicomStoresResponse { - /** - * The returned DICOM stores. Won't be more DICOM stores than the value - * of page_size in the request. - */ - dicomStores?: Schema$DicomStore[]; - /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. - */ - nextPageToken?: string; - } - /** - * Lists the FHIR stores in the given dataset. - */ - export interface Schema$ListFhirStoresResponse { - /** - * The returned FHIR stores. Won't be more FHIR stores than the value of - * page_size in the request. - */ - fhirStores?: Schema$FhirStore[]; - /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. - */ - nextPageToken?: string; - } - /** - * Lists the HL7v2 stores in the given dataset. - */ - export interface Schema$ListHl7V2StoresResponse { - /** - * The returned HL7v2 stores. Won't be more HL7v2 stores than the value - * of page_size in the request. - */ - hl7V2Stores?: Schema$Hl7V2Store[]; - /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. - */ - 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; - } - /** - * Lists the messages in the specified HL7v2 store. - */ - export interface Schema$ListMessagesResponse { - /** - * The returned message names. Won't be more values than the value of - * page_size in the request. - */ - messages?: string[]; - /** - * Token to retrieve the next page of results or empty if there are no more - * results in the list. - */ - nextPageToken?: 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[]; - } - /** - * 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 complete HL7v2 message. See - * http://www.hl7.org/implement/standards/index.cfm?ref=common for details on - * the standard. + * The `Status` type defines a logical error model that is suitable for + * different programming environments, including REST APIs and RPC APIs. It is + * used by [gRPC](https://github.com/grpc). The error model is designed to be: + * - Simple to use and understand for most users - Flexible enough to meet + * unexpected needs # Overview The `Status` message contains three pieces of + * data: error code, error message, and error details. The error code should + * be an enum value of google.rpc.Code, but it may accept additional error + * codes if needed. The error message should be a developer-facing English + * message that helps developers *understand* and *resolve* the error. If a + * localized user-facing error message is needed, put the localized message in + * the error details or localize it in the client. The optional error details + * may contain arbitrary information about the error. There is a predefined + * set of error detail types in the package `google.rpc` that can be used for + * common error conditions. # Language mapping The `Status` message is the + * logical representation of the error model, but it is not necessarily the + * actual wire format. When the `Status` message is exposed in different + * client libraries and different wire protocols, it can be mapped + * differently. For example, it will likely be mapped to some exceptions in + * Java, but more likely mapped to some error codes in C. # Other uses The + * error model and the `Status` message can be used in a variety of + * environments, either with or without APIs, to provide a consistent + * developer experience across different environments. Example uses of this + * error model include: - Partial errors. If a service needs to return + * partial errors to the client, it may embed the `Status` in the normal + * response to indicate the partial errors. - Workflow errors. A typical + * workflow has multiple steps. Each step may have a `Status` message for + * error reporting. - Batch operations. If a client uses batch request and + * batch response, the `Status` message should be used directly inside + * batch response, one for each error sub-response. - Asynchronous + * operations. If an API call embeds asynchronous operation results in its + * response, the status of those operations should be represented directly + * using the `Status` message. - Logging. If some API errors are stored in + * logs, the message `Status` could be used directly after any stripping + * needed for security/privacy reasons. */ - export interface Schema$Message { - /** - * The datetime when the message was created. Set by the server. - */ - createTime?: string; - /** - * Raw message bytes. - */ - data?: string; - /** - * User-supplied key-value pairs used to organize HL7v2 stores. Label keys - * must be between 1 and 63 characters long, have a UTF-8 encoding of - * maximum 128 bytes, and must conform to the following PCRE regular - * expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be - * between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 - * bytes, and must conform to the following PCRE regular expression: - * [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated - * with a given store. - */ - labels?: {[key: string]: string;}; - /** - * The message type and trigger event for this message. MSH-9. - */ - messageType?: string; - /** - * 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?: string; - /** - * The parsed version of the raw message data. - */ - parsedData?: Schema$ParsedData; - /** - * All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this - * message. - */ - patientIds?: Schema$PatientId[]; + export interface Schema$Status { /** - * The hospital that this message came from. MSH-4. + * The status code, which should be an enum value of google.rpc.Code. */ - sendFacility?: string; + code?: number; /** - * The datetime the sending application sent this message. MSH-7. + * A list of messages that carry the error details. There is a common set + * of message types for APIs to use. */ - sendTime?: string; - } - /** - * Specifies where notifications should be sent upon changes to a data store. - */ - export interface Schema$NotificationConfig { + details?: Array<{[key: string]: any;}>; /** - * The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that - * notifications of changes are published on. Supplied by the client. - * PubsubMessage.Data will contain the resource name. - * PubsubMessage.MessageId is the ID of this message. It is guaranteed to be - * unique within the topic. PubsubMessage.PublishTime is the time at which - * the message was published. Notifications are only sent if the topic is - * non-empty. [Topic - * names](https://cloud.google.com/pubsub/docs/overview#names) must be - * scoped to a project. cloud-healthcare@system.gserviceaccount.com must - * have publisher permissions on the given Cloud Pub/Sub topic. Not having - * adequate permissions will cause the calls that send notifications to - * fail. + * 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. */ - pubsubTopic?: string; + message?: string; } /** - * This resource represents a long-running operation that is the result of a - * network API call. + * Request message for `TestIamPermissions` method. */ - 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 have the format of `operations/some/unique/name`. - */ - name?: string; + export interface Schema$TestIamPermissionsRequest { /** - * 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`. + * The set of permissions to check for the `resource`. Permissions with + * wildcards (such as '*' or 'storage.*') are not allowed. + * For more information see [IAM + * Overview](https://cloud.google.com/iam/docs/overview#permissions). */ - response?: {[key: string]: any;}; + permissions?: string[]; } /** - * OperationMetadata provides information about the operation execution. - * Returned in the long-running operation's metadata field. + * Response message for `TestIamPermissions` method. */ - export interface Schema$OperationMetadata { + export interface Schema$TestIamPermissionsResponse { /** - * The name of the API method that initiated the operation. - */ - apiMethodName?: string; - counter?: Schema$ProgressCounter; - /** - * The time at which the operation was created by the API. - */ - createTime?: string; - /** - * The time at which execution was completed. - */ - endTime?: string; - } - /** - * Specifies the location(s) to which data should be exported. - */ - export interface Schema$OutputConfig { - /** - * BigQueryDestination requires two IAM roles: `roles/bigquery.dataEditor` - * and `roles/bigquery.jobUser`. - */ - bigQueryDestination?: Schema$BigQueryDestination; - /** - * GcsDestination requires `roles/storage.objectAdmin` Cloud IAM role. Note - * that writing a file to the same destination multiple times will result in - * the previous version of the file being overwritten. - */ - gcsDestination?: Schema$GcsDestination; - } - /** - * The content of a HL7v2 message in a structured format. - */ - export interface Schema$ParsedData { - segments?: Schema$Segment[]; - } - /** - * The configuration for the parser. It determines how the server parses the - * messages. - */ - export interface Schema$ParserConfig { - /** - * Determines whether messages with no header are allowed. - */ - allowNullHeader?: boolean; - /** - * Byte(s) to be used as the segment terminator. If this is unset, - * '\r' will be used as segment terminator. - */ - segmentTerminator?: string; - } - /** - * A patient identifier and associated type. - */ - export interface Schema$PatientId { - /** - * ID type, e.g. MRN or NHS. - */ - type?: string; - /** - * The patient's unique identifier. - */ - value?: string; - } - /** - * Defines an Identity and Access Management (IAM) policy. It is used to - * specify access control policies for Cloud Platform resources. A `Policy` - * consists of a list of `bindings`. A `binding` binds a list of `members` to - * a `role`, where the members can be user accounts, Google groups, Google - * domains, and service accounts. A `role` is a named list of permissions - * defined by IAM. **JSON Example** { "bindings": [ { - * "role": "roles/owner", "members": [ - * "user:mike@example.com", "group:admins@example.com", - * "domain:google.com", - * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { - * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } **YAML - * Example** bindings: - members: - user:mike@example.com - - * group:admins@example.com - domain:google.com - - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: - * roles/owner - members: - user:sean@example.com role: - * roles/viewer For a description of IAM and its features, see the [IAM - * developer's guide](https://cloud.google.com/iam/docs). - */ - export interface Schema$Policy { - /** - * Specifies cloud audit logging configuration for this policy. - */ - auditConfigs?: Schema$AuditConfig[]; - /** - * Associates a list of `members` to a `role`. `bindings` with no members - * will result in an error. - */ - bindings?: Schema$Binding[]; - /** - * `etag` is used for optimistic concurrency control as a way to help - * prevent simultaneous updates of a policy from overwriting each other. It - * is strongly suggested that systems make use of the `etag` in the - * read-modify-write cycle to perform policy updates in order to avoid race - * conditions: An `etag` is returned in the response to `getIamPolicy`, and - * systems are expected to put that etag in the request to `setIamPolicy` to - * ensure that their change will be applied to the same version of the - * policy. If no `etag` is provided in the call to `setIamPolicy`, then the - * existing policy is overwritten blindly. - */ - etag?: string; - /** - * Deprecated. - */ - version?: number; - } - /** - * ProgressCounter provides counters to describe an operation's progress. - */ - export interface Schema$ProgressCounter { - /** - * The number of units that failed in the operation. - */ - failure?: string; - /** - * The number of units that are pending in the operation. - */ - pending?: string; - /** - * The number of units that succeeded in the operation. - */ - success?: string; - } - /** - * Resource level annotation. - */ - export interface Schema$ResourceAnnotation { - label?: string; - } - /** - * Configuration for the FHIR BigQuery schema. Determines how the server - * generates the schema. - */ - export interface Schema$SchemaConfig { - /** - * The depth for all recursive structures in the output analytics schema. - * For example, concept in the CodeSystem resource is a recursive structure; - * when the depth is 2, the CodeSystem table will have a column called - * `concept.concept` but not `concept.concept.concept`. If not specified or - * set to 0, the server will use the default value 2. - */ - recursiveStructureDepth?: string; - /** - * Specifies the output schema type. If unspecified, the default is - * `LOSSLESS`. - */ - schemaType?: string; - } - /** - * Request to search the resources in the specified FHIR store. - */ - export interface Schema$SearchResourcesRequest { - /** - * The type of the resource to search. - */ - resourceType?: string; - } - /** - * A segment in a structured format. - */ - export interface Schema$Segment { - /** - * A mapping from the positional location to the value. The key string uses - * indexes separated by dots to identify Fields, components and - * sub-components. To be consistent with how the standard refers to - * different parts of message, we use zero-based indexes for fields and - * one-based indexes for components and sub-components. A bracket notation - * is also used to identify different instances of a repeated field. - * Zero-based indexes are used to refer to each instance. Regex for key: - * (\d+)(\[\d+\])?(.\d+)?(.\d+)? Examples of (key, value) pairs: (0.1, - * "foo") denotes First component of Field 0 has the value - * "foo". (1.1.2, "bar") denotes Second sub-component - * of the first component of Field 1 has the value "bar". (1[0].1, - * "baz") denotes First component of the first Instance of Field - * 1, which is repeated, has the value "baz". - */ - fields?: {[key: string]: string;}; - /** - * A string that indicates the type of segment, e.g., EVN, PID. - */ - segmentId?: string; - /** - * Set ID for segments that can be in a set. This can be empty if it is - * missing or it is not applicable. - */ - setId?: string; - } - /** - * A TextAnnotation specifies a text range that includes sensitive - * information. - */ - export interface Schema$SensitiveTextAnnotation { - /** - * Maps from a resource slice (e.g. FHIR resource field path) to a set of - * sensitive text findings. For example, Appointment.Narrative text1 --> - * {findings_1, findings_2, findings_3} - */ - details?: {[key: string]: Schema$Detail;}; - } - /** - * Request message for `SetIamPolicy` method. - */ - export interface Schema$SetIamPolicyRequest { - /** - * REQUIRED: The complete policy to be applied to the `resource`. The size - * of the policy is limited to a few 10s of KB. An empty policy is a valid - * policy but certain Cloud Platform services (such as Projects) might - * reject them. - */ - policy?: Schema$Policy; - /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. - * Only the fields in the mask will be modified. If no mask is provided, the - * following default mask is used: paths: "bindings, etag" This - * field is only used by Cloud IAM. - */ - updateMask?: string; - } - /** - * The `Status` type defines a logical error model that is suitable for - * different programming environments, including REST APIs and RPC APIs. It is - * used by [gRPC](https://github.com/grpc). The error model is designed to be: - * - Simple to use and understand for most users - Flexible enough to meet - * unexpected needs # Overview The `Status` message contains three pieces of - * data: error code, error message, and error details. The error code should - * be an enum value of google.rpc.Code, but it may accept additional error - * codes if needed. The error message should be a developer-facing English - * message that helps developers *understand* and *resolve* the error. If a - * localized user-facing error message is needed, put the localized message in - * the error details or localize it in the client. The optional error details - * may contain arbitrary information about the error. There is a predefined - * set of error detail types in the package `google.rpc` that can be used for - * common error conditions. # Language mapping The `Status` message is the - * logical representation of the error model, but it is not necessarily the - * actual wire format. When the `Status` message is exposed in different - * client libraries and different wire protocols, it can be mapped - * differently. For example, it will likely be mapped to some exceptions in - * Java, but more likely mapped to some error codes in C. # Other uses The - * error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a consistent - * developer experience across different environments. Example uses of this - * error model include: - Partial errors. If a service needs to return - * partial errors to the client, it may embed the `Status` in the normal - * response to indicate the partial errors. - Workflow errors. A typical - * workflow has multiple steps. Each step may have a `Status` message for - * error reporting. - Batch operations. If a client uses batch request and - * batch response, the `Status` message should be used directly inside - * batch response, one for each error sub-response. - Asynchronous - * operations. If an API call embeds asynchronous operation results in its - * response, the status of those operations should be represented directly - * using the `Status` message. - Logging. If some API errors are stored in - * logs, the message `Status` could be used directly after any stripping - * needed for security/privacy reasons. - */ - export interface Schema$Status { - /** - * The status code, which should be an enum value of google.rpc.Code. - */ - code?: number; - /** - * A list of messages that carry the error details. There is a common set - * of message types for APIs to use. - */ - details?: 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; - } - /** - * Request message for `TestIamPermissions` method. - */ - export interface Schema$TestIamPermissionsRequest { - /** - * The set of permissions to check for the `resource`. Permissions with - * wildcards (such as '*' or 'storage.*') are not allowed. - * For more information see [IAM - * Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - } - /** - * Response message for `TestIamPermissions` method. - */ - export interface Schema$TestIamPermissionsResponse { - /** - * A subset of `TestPermissionsRequest.permissions` that the caller is - * allowed. - */ - permissions?: string[]; - } - /** - * A 2D coordinate in an image. The origin is the top-left. - */ - export interface Schema$Vertex { - /** - * X coordinate. - */ - x?: number; - /** - * Y coordinate. - */ - y?: number; - } - - - 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; - datasets: Resource$Projects$Locations$Datasets; - constructor(context: APIRequestContext) { - this.context = context; - this.datasets = new Resource$Projects$Locations$Datasets(this.context); - } - - - /** - * healthcare.projects.locations.get - * @desc Gets information about a location. - * @alias healthcare.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://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.list - * @desc Lists information about the supported locations for this service. - * @alias healthcare.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://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+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; - } - - export class Resource$Projects$Locations$Datasets { - context: APIRequestContext; - annotationStores: Resource$Projects$Locations$Datasets$Annotationstores; - dicomStores: Resource$Projects$Locations$Datasets$Dicomstores; - fhirStores: Resource$Projects$Locations$Datasets$Fhirstores; - hl7V2Stores: Resource$Projects$Locations$Datasets$Hl7v2stores; - operations: Resource$Projects$Locations$Datasets$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.annotationStores = - new Resource$Projects$Locations$Datasets$Annotationstores( - this.context); - this.dicomStores = - new Resource$Projects$Locations$Datasets$Dicomstores(this.context); - this.fhirStores = - new Resource$Projects$Locations$Datasets$Fhirstores(this.context); - this.hl7V2Stores = - new Resource$Projects$Locations$Datasets$Hl7v2stores(this.context); - this.operations = - new Resource$Projects$Locations$Datasets$Operations(this.context); - } - - - /** - * healthcare.projects.locations.datasets.create - * @desc Creates a new health dataset. - * @alias healthcare.projects.locations.datasets.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.datasetId The ID of the dataset that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - * @param {string} params.parent The name of the project in which the dataset should be created (e.g., `projects/{project_id}/locations/{location_id}`). - * @param {().Dataset} 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$Datasets$Create, - options?: MethodOptions): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datasets$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/datasets') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * 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. - * @alias healthcare.projects.locations.datasets.deidentify - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.sourceDataset Source dataset resource name. (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). - * @param {().DeidentifyDatasetRequest} 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$Datasets$Deidentify, - options?: MethodOptions): GaxiosPromise; - deidentify( - params: Params$Resource$Projects$Locations$Datasets$Deidentify, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - deidentify( - params: Params$Resource$Projects$Locations$Datasets$Deidentify, - callback: BodyResponseCallback): void; - deidentify(callback: BodyResponseCallback): void; - deidentify( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Deidentify| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Deidentify; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Deidentify; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+sourceDataset}:deidentify') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['sourceDataset'], - pathParams: ['sourceDataset'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * 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). - * @alias healthcare.projects.locations.datasets.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the dataset to delete (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_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$Projects$Locations$Datasets$Delete, - options?: MethodOptions): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.get - * @desc Gets any metadata associated with a dataset. - * @alias healthcare.projects.locations.datasets.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the dataset to read (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_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$Datasets$Get, - options?: MethodOptions): GaxiosPromise; - get(params: Params$Resource$Projects$Locations$Datasets$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Projects$Locations$Datasets$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * 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. - * @alias healthcare.projects.locations.datasets.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 {object} [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$Locations$Datasets$Getiampolicy, - options?: MethodOptions): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, - callback: BodyResponseCallback): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Getiampolicy| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.list - * @desc Lists the health datasets in the current project. - * @alias healthcare.projects.locations.datasets.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize The maximum number of items to return. Capped to 100 if not specified. May not be larger than 1000. - * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. - * @param {string} params.parent The name of the project whose datasets should be listed (e.g., `projects/{project_id}/locations/{location_id}`). - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Locations$Datasets$List, - options?: MethodOptions): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Projects$Locations$Datasets$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/datasets') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.patch - * @desc Updates dataset metadata. - * @alias healthcare.projects.locations.datasets.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Output only. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. - * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * @param {().Dataset} 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$Datasets$Patch, - options?: MethodOptions): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. - * @alias healthcare.projects.locations.datasets.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$Locations$Datasets$Setiampolicy, - options?: MethodOptions): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, - callback: BodyResponseCallback): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Setiampolicy| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+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); - } - } - - - /** - * 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. - * @alias healthcare.projects.locations.datasets.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$Locations$Datasets$Testiampermissions, - options?: MethodOptions): - GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, - callback: BodyResponseCallback): - void; - testIamPermissions( - callback: BodyResponseCallback): - void; - testIamPermissions( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Testiampermissions| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+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$Locations$Datasets$Create extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the dataset that is being created. The string must match the - * following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - */ - datasetId?: string; - /** - * The name of the project in which the dataset should be created (e.g., - * `projects/{project_id}/locations/{location_id}`). - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Dataset; - } - export interface Params$Resource$Projects$Locations$Datasets$Deidentify - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Source dataset resource name. (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). - */ - sourceDataset?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DeidentifyDatasetRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Delete extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of the dataset to delete (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Get extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of the dataset to read (e.g., - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$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; - } - export interface Params$Resource$Projects$Locations$Datasets$List extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The maximum number of items to return. Capped to 100 if not specified. - * May not be larger than 1000. - */ - pageSize?: number; - /** - * The next_page_token value returned from a previous List request, if any. - */ - pageToken?: string; - /** - * The name of the project whose datasets should be listed (e.g., - * `projects/{project_id}/locations/{location_id}`). - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Patch extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Output only. Resource name of the dataset, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. - */ - name?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Dataset; - } - export interface Params$Resource$Projects$Locations$Datasets$Setiampolicy - 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 specified. See the - * operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Testiampermissions - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Datasets$Annotationstores { - context: APIRequestContext; - annotations: - Resource$Projects$Locations$Datasets$Annotationstores$Annotations; - constructor(context: APIRequestContext) { - this.context = context; - this.annotations = - new Resource$Projects$Locations$Datasets$Annotationstores$Annotations( - this.context); - } - - - /** - * healthcare.projects.locations.datasets.annotationStores.create - * @desc Creates a new Annotation store within the parent dataset. - * @alias healthcare.projects.locations.datasets.annotationStores.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.annotationStoreId The ID of the Annotation store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - * @param {string} params.parent The name of the dataset this Annotation store belongs to. - * @param {().AnnotationStore} 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$Datasets$Annotationstores$Create, - options?: MethodOptions): GaxiosPromise; - create( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - create( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/annotationStores') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.annotationStores.delete - * @desc Deletes the specified Annotation store and removes all annotations - * that are contained within it. - * @alias healthcare.projects.locations.datasets.annotationStores.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Annotation store 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$Projects$Locations$Datasets$Annotationstores$Delete, - options?: MethodOptions): GaxiosPromise; - delete( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.annotationStores.get - * @desc Gets the specified Annotation store or returns NOT_FOUND if it does - * not exist. - * @alias healthcare.projects.locations.datasets.annotationStores.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Annotation store 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$Datasets$Annotationstores$Get, - options?: MethodOptions): GaxiosPromise; - get(params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.annotationStores.getIamPolicy - * @desc Gets the access control policy for a resource. 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.AnnotationStores.getIamPolicy` on - * the specified resource - * @alias - * healthcare.projects.locations.datasets.annotationStores.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$Locations$Datasets$Annotationstores$Getiampolicy, - options?: MethodOptions): GaxiosPromise; - getIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - getIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy, - callback: BodyResponseCallback): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+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); - } - } - - - /** - * healthcare.projects.locations.datasets.annotationStores.list - * @desc Lists the Annotation stores in the given dataset for a source - * store. - * @alias healthcare.projects.locations.datasets.annotationStores.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. - * @param {integer=} params.pageSize Limit on the number of Annotation stores to return in a single response. If zero the default page size of 100 is used. - * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. - * @param {string} params.parent Name of the dataset. - * @param {object} [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$Datasets$Annotationstores$List, - options?: MethodOptions): - GaxiosPromise; - list( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Annotationstores$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Annotationstores$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Annotationstores$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/annotationStores') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.annotationStores.patch - * @desc Updates the specified Annotation store. - * @alias healthcare.projects.locations.datasets.annotationStores.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Output only. Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. - * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * @param {().AnnotationStore} 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$Datasets$Annotationstores$Patch, - options?: MethodOptions): GaxiosPromise; - patch( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * 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 - * @alias - * healthcare.projects.locations.datasets.annotationStores.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$Locations$Datasets$Annotationstores$Setiampolicy, - options?: MethodOptions): GaxiosPromise; - setIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - setIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy, - callback: BodyResponseCallback): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+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); - } - } - - - /** - * healthcare.projects.locations.datasets.annotationStores.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. There is no permission required to - * make this API call. - * @alias - * healthcare.projects.locations.datasets.annotationStores.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$Locations$Datasets$Annotationstores$Testiampermissions, - options?: MethodOptions): - GaxiosPromise; - testIamPermissions( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - testIamPermissions( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions, - callback: BodyResponseCallback): - void; - testIamPermissions( - callback: BodyResponseCallback): - void; - testIamPermissions( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+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$Locations$Datasets$Annotationstores$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the Annotation store that is being created. The string must - * match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - */ - annotationStoreId?: string; - /** - * The name of the dataset this Annotation store belongs to. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AnnotationStore; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The resource name of the Annotation store to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The resource name of the Annotation store to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$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$Locations$Datasets$Annotationstores$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Restricts stores returned to those matching a filter. Syntax: - * https://cloud.google.com/appengine/docs/standard/python/search/query_strings - * Only filtering on labels is supported, for example `labels.key=value`. - */ - filter?: string; - /** - * Limit on the number of Annotation stores to return in a single response. - * If zero the default page size of 100 is used. - */ - pageSize?: number; - /** - * The next_page_token value returned from the previous List request, if - * any. - */ - pageToken?: string; - /** - * Name of the dataset. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Output only. Resource name of the Annotation store, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. - */ - name?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AnnotationStore; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy - 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 specified. See the - * operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class - Resource$Projects$Locations$Datasets$Annotationstores$Annotations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - - /** - * healthcare.projects.locations.datasets.annotationStores.annotations.create - * @desc Creates a new Annotation record. It is valid to create Annotation - * objects for the same source more than once since a unique ID is assigned - * to each record by this service. - * @alias - * healthcare.projects.locations.datasets.annotationStores.annotations.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. - * @param {().Annotation} 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$Datasets$Annotationstores$Annotations$Create, - options?: MethodOptions): GaxiosPromise; - create( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - create( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/annotations') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.annotationStores.annotations.delete - * @desc Deletes an Annotation or returns NOT_FOUND if it does not exist. - * @alias - * healthcare.projects.locations.datasets.annotationStores.annotations.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Annotation 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$Projects$Locations$Datasets$Annotationstores$Annotations$Delete, - options?: MethodOptions): GaxiosPromise; - delete( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.annotationStores.annotations.get - * @desc Gets an Annotation. - * @alias - * healthcare.projects.locations.datasets.annotationStores.annotations.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Annotation 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$Projects$Locations$Datasets$Annotationstores$Annotations$Get, - options?: MethodOptions): GaxiosPromise; - get(params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.annotationStores.annotations.list - * @desc Lists the Annotations in the given Annotation store for a source - * resource. - * @alias - * healthcare.projects.locations.datasets.annotationStores.annotations.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter Restricts Annotations returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: - source_version - * @param {integer=} params.pageSize Limit on the number of Annotations to return in a single response. If zero the default page size of 100 is used. - * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. - * @param {string} params.parent Name of the Annotation store to retrieve Annotations from. - * @param {object} [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$Datasets$Annotationstores$Annotations$List, - options?: MethodOptions): GaxiosPromise; - list( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/annotations') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.annotationStores.annotations.patch - * @desc Updates the Annotation. - * @alias - * healthcare.projects.locations.datasets.annotationStores.annotations.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Output only. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. - * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * @param {().Annotation} 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$Datasets$Annotationstores$Annotations$Patch, - options?: MethodOptions): GaxiosPromise; - patch( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+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$Locations$Datasets$Annotationstores$Annotations$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of the Annotation store this annotation belongs to. For example, - * `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Annotation; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The resource name of the Annotation to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The resource name of the Annotation to retrieve. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Restricts Annotations returned to those matching a filter. Syntax: - * https://cloud.google.com/appengine/docs/standard/python/search/query_strings - * Fields/functions available for filtering are: - source_version - */ - filter?: string; - /** - * Limit on the number of Annotations to return in a single response. If - * zero the default page size of 100 is used. - */ - pageSize?: number; - /** - * The next_page_token value returned from the previous List request, if - * any. - */ - pageToken?: string; - /** - * Name of the Annotation store to retrieve Annotations from. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Output only. Resource name of the Annotation, of the form - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. - */ - name?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Annotation; - } - - - - export class Resource$Projects$Locations$Datasets$Dicomstores { - context: APIRequestContext; - dicomWeb: Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb; - constructor(context: APIRequestContext) { - this.context = context; - this.dicomWeb = - new Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb( - this.context); - } - - - /** - * healthcare.projects.locations.datasets.dicomStores.create - * @desc Creates a new DICOM store within the parent dataset. - * @alias healthcare.projects.locations.datasets.dicomStores.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.dicomStoreId The ID of the DICOM store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - * @param {string} params.parent The name of the dataset this DICOM store belongs to. - * @param {().DicomStore} 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$Datasets$Dicomstores$Create, - options?: MethodOptions): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/dicomStores') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.dicomStores.delete - * @desc Deletes the specified DICOM store and removes all images that are - * contained within it. - * @alias healthcare.projects.locations.datasets.dicomStores.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the DICOM store 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$Projects$Locations$Datasets$Dicomstores$Delete, - options?: MethodOptions): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * 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. - * @alias healthcare.projects.locations.datasets.dicomStores.export - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name 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}`). - * @param {().ExportDicomDataRequest} 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$Datasets$Dicomstores$Export, - options?: MethodOptions): GaxiosPromise; - export( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Export, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - export( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Export, - callback: BodyResponseCallback): void; - export(callback: BodyResponseCallback): void; - export( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Export| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Export; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Export; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+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); - } - } - - - /** - * healthcare.projects.locations.datasets.dicomStores.get - * @desc Gets the specified DICOM store. - * @alias healthcare.projects.locations.datasets.dicomStores.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the DICOM store 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$Datasets$Dicomstores$Get, - options?: MethodOptions): GaxiosPromise; - get(params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * 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. - * @alias healthcare.projects.locations.datasets.dicomStores.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 {object} [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$Locations$Datasets$Dicomstores$Getiampolicy, - options?: MethodOptions): GaxiosPromise; - getIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - getIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy, - callback: BodyResponseCallback): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - -/** - * 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. - * @alias healthcare.projects.locations.datasets.dicomStores.import - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name 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}`). - * @param {().ImportDicomDataRequest} 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$Datasets$Dicomstores$Import, options?: MethodOptions): GaxiosPromise; -import(params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Import, options: MethodOptions|BodyResponseCallback, callback: BodyResponseCallback): void; -import(params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Import, callback: BodyResponseCallback): void; -import(callback: BodyResponseCallback): void; -import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Import|BodyResponseCallback, optionsOrCallback?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void|GaxiosPromise {let params = (paramsOrCallback || {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Import; let options = (optionsOrCallback || {}) as MethodOptions; - - if(typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Import; - options = {}; - } - - if(typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; const parameters = {options: Object.assign({url: (rootUrl + '/v1alpha/{+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); - }} - - - /** - * healthcare.projects.locations.datasets.dicomStores.list - * @desc Lists the DICOM stores in the given dataset. - * @alias healthcare.projects.locations.datasets.dicomStores.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Limit on the number of DICOM stores to return in a single response. If zero the default page size of 100 is used. - * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. - * @param {string} params.parent Name of the dataset. - * @param {object} [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$Datasets$Dicomstores$List, options?: MethodOptions): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Dicomstores$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Dicomstores$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Dicomstores$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/dicomStores') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.dicomStores.patch - * @desc Updates the specified DICOM store. - * @alias healthcare.projects.locations.datasets.dicomStores.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Output only. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. - * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * @param {().DicomStore} 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$Datasets$Dicomstores$Patch, - options?: MethodOptions): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.dicomStores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. - * @alias healthcare.projects.locations.datasets.dicomStores.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$Locations$Datasets$Dicomstores$Setiampolicy, - options?: MethodOptions): GaxiosPromise; - setIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - setIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy, - callback: BodyResponseCallback): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+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); - } - } - - - /** - * 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. - * @alias - * healthcare.projects.locations.datasets.dicomStores.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$Locations$Datasets$Dicomstores$Testiampermissions, - options?: MethodOptions): - GaxiosPromise; - testIamPermissions( - params: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - testIamPermissions( - params: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions, - callback: BodyResponseCallback): - void; - testIamPermissions( - callback: BodyResponseCallback): - void; - testIamPermissions( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+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$Locations$Datasets$Dicomstores$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the DICOM store that is being created. The string must match - * the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - */ - dicomStoreId?: string; - /** - * The name of the dataset this DICOM store belongs to. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DicomStore; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The resource name of the DICOM store to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Export - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * 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?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ExportDicomDataRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The resource name of the DICOM store to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$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; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Import - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * 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?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ImportDicomDataRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Limit on the number of DICOM stores to return in a single response. If - * zero the default page size of 100 is used. - */ - pageSize?: number; - /** - * The next_page_token value returned from the previous List request, if - * any. - */ - pageToken?: string; - /** - * Name of the dataset. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * 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?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DicomStore; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy - 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 specified. See the - * operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.dicomWebDelete - * @desc Handles DELETE requests equivalent to the GET requests specified in - * the WADO-RS standard. Since this implements an industry standard API, the - * dicom_web_path is interpreted directly by the serving binary. For - * example, if the request is for - * `/v1alpha/projects/{project_id}/locations/{location_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/1.2`, - * then `/studies/1.2` is passed to the serving binary as the - * dicom_web_path. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.dicomWebDelete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the WADO-RS standard. - * @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 - */ - dicomWebDelete( - params?: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebdelete, - options?: MethodOptions): GaxiosPromise; - dicomWebDelete( - params: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebdelete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - dicomWebDelete( - params: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebdelete, - callback: BodyResponseCallback): void; - dicomWebDelete(callback: BodyResponseCallback): void; - dicomWebDelete( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebdelete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebdelete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebdelete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/dicomWeb/{+dicomWebPath}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.dicomWebGet - * @desc Handles the GET requests specified in the STOW-RS, WADO-RS, or - * QIDO-RS standard. Since this implements an industry standard API, the - * dicom_web_path is interpreted directly by the serving binary. For - * example, if the request is for - * `/v1alpha/projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_id}/series?PatientName={patient_name}`, - * then `studies/{study_id}/series` is passed to the serving binary as the - * dicom_web_path. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.dicomWebGet - * @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`). - * @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 - */ - dicomWebGet( - params?: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebget, - options?: MethodOptions): GaxiosPromise; - dicomWebGet( - params: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebget, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - dicomWebGet( - params: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebget, - callback: BodyResponseCallback): void; - dicomWebGet(callback: BodyResponseCallback): void; - dicomWebGet( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebget| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebget; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebget; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/dicomWeb/{+dicomWebPath}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.dicomWebPost - * @desc Handles the POST requests specified in the STOW-RS, WADO-RS, or - * QIDO-RS standard. Since this implements an industry standard API, the - * dicom_web_path is interpreted directly by the serving binary. For - * example, if the request is for - * `/v1alpha/projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_id}`, - * then `/studies/{study_id}` is passed to the serving binary as the - * dicom_web_path. - * @alias - * healthcare.projects.locations.datasets.dicomStores.dicomWeb.dicomWebPost - * @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.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`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - dicomWebPost( - params?: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebpost, - options?: MethodOptions): GaxiosPromise; - dicomWebPost( - params: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebpost, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - dicomWebPost( - params: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebpost, - callback: BodyResponseCallback): void; - dicomWebPost(callback: BodyResponseCallback): void; - dicomWebPost( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebpost| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebpost; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebpost; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/dicomWeb/{+dicomWebPath}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent', 'dicomWebPath'], - pathParams: ['dicomWebPath', 'parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebdelete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The path of the DICOMweb request, as specified in the WADO-RS standard. - */ - dicomWebPath?: string; - /** - * 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?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebget - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - 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`). - */ - dicomWebPath?: string; - /** - * 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?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebpost - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - 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}`). - */ - dicomWebPath?: string; - /** - * 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?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - - - - export class Resource$Projects$Locations$Datasets$Fhirstores { - context: APIRequestContext; - resources: Resource$Projects$Locations$Datasets$Fhirstores$Resources; - securityLabels: - Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels; - constructor(context: APIRequestContext) { - this.context = context; - this.resources = - new Resource$Projects$Locations$Datasets$Fhirstores$Resources( - this.context); - this.securityLabels = - new Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels( - this.context); - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.create - * @desc Creates a new FHIR store within the parent dataset. - * @alias healthcare.projects.locations.datasets.fhirStores.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.fhirStoreId The ID of the FHIR store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - * @param {string} params.parent The name of the dataset this FHIR store belongs to. - * @param {().FhirStore} 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$Datasets$Fhirstores$Create, - options?: MethodOptions): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/fhirStores') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.delete - * @desc Deletes the FHIR store and removes all resources that are contained - * within it. - * @alias healthcare.projects.locations.datasets.fhirStores.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the FHIR store 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$Projects$Locations$Datasets$Fhirstores$Delete, - options?: MethodOptions): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.executeBundle - * @desc Executes all the requests in the given Bundle. - * @alias healthcare.projects.locations.datasets.fhirStores.executeBundle - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent Name of the FHIR store in which this bundle will be executed. - * @param {().HttpBody} 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 - */ - executeBundle( - params?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle, - options?: MethodOptions): GaxiosPromise; - executeBundle( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - executeBundle( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle, - callback: BodyResponseCallback): void; - executeBundle(callback: BodyResponseCallback): void; - executeBundle( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.export - * @desc Export resources from the FHIR store to the specified destination. - * Fatal errors will be populated in the error field. Otherwise a detailed - * response will be returned as of type ExportResourcesResponse contained in - * the response field when the operation finishes. The metadata field type - * is OperationMetadata. - * @alias healthcare.projects.locations.datasets.fhirStores.export - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The FHIR store name to export from. The name should be in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - * @param {().ExportResourcesRequest} 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$Datasets$Fhirstores$Export, - options?: MethodOptions): GaxiosPromise; - export( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Export, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - export( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Export, - callback: BodyResponseCallback): void; - export(callback: BodyResponseCallback): void; - export( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Export| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Export; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Export; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+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); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.get - * @desc Gets the specified FHIR store. - * @alias healthcare.projects.locations.datasets.fhirStores.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the FHIR store 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$Datasets$Fhirstores$Get, - options?: MethodOptions): GaxiosPromise; - get(params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * 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 - * @alias healthcare.projects.locations.datasets.fhirStores.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$Locations$Datasets$Fhirstores$Getiampolicy, - options?: MethodOptions): GaxiosPromise; - getIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - getIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy, - callback: BodyResponseCallback): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+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); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.getMetadata - * @desc Gets the capabilities statement for the store. - * @alias healthcare.projects.locations.datasets.fhirStores.getMetadata - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Name of the FHIR store to retrieve the capabilities 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 - */ - getMetadata( - params?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata, - options?: MethodOptions): GaxiosPromise; - getMetadata( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - getMetadata( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata, - callback: BodyResponseCallback): void; - getMetadata(callback: BodyResponseCallback): void; - getMetadata( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}/metadata') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - -/** - * healthcare.projects.locations.datasets.fhirStores.import - * @desc Import resources to the FHIR store by loading data from the specified - * sources. Fatal errors will be populated in the error field. Otherwise a - * detailed response will be returned as of type ImportResourcesResponse - * contained in the response field when the operation finishes. The metadata - * field type is OperationMetadata. - * @alias healthcare.projects.locations.datasets.fhirStores.import - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The FHIR store name to import FHIR resources to. The name should be in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - * @param {().ImportResourcesRequest} 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$Datasets$Fhirstores$Import, options?: MethodOptions): GaxiosPromise; -import(params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Import, options: MethodOptions|BodyResponseCallback, callback: BodyResponseCallback): void; -import(params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Import, callback: BodyResponseCallback): void; -import(callback: BodyResponseCallback): void; -import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Import|BodyResponseCallback, optionsOrCallback?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void|GaxiosPromise {let params = (paramsOrCallback || {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Import; let options = (optionsOrCallback || {}) as MethodOptions; - - if(typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Import; - options = {}; - } - - if(typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; const parameters = {options: Object.assign({url: (rootUrl + '/v1alpha/{+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); - }} - - - /** - * healthcare.projects.locations.datasets.fhirStores.list - * @desc Lists the FHIR stores in the given dataset. - * @alias healthcare.projects.locations.datasets.fhirStores.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Limit on the number of FHIR stores to return in a single response. If zero the default page size of 100 is used. - * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. - * @param {string} params.parent Name of the dataset. - * @param {object} [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$Datasets$Fhirstores$List, options?: MethodOptions): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/fhirStores') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.patch - * @desc Updates the FHIR store. - * @alias healthcare.projects.locations.datasets.fhirStores.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * @param {().FhirStore} 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$Datasets$Fhirstores$Patch, - options?: MethodOptions): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * 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 - * @alias healthcare.projects.locations.datasets.fhirStores.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$Locations$Datasets$Fhirstores$Setiampolicy, - options?: MethodOptions): GaxiosPromise; - setIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - setIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy, - callback: BodyResponseCallback): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+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); - } - } - - - /** - * 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. There is no permission required to - * make this API call. - * @alias - * healthcare.projects.locations.datasets.fhirStores.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$Locations$Datasets$Fhirstores$Testiampermissions, - options?: MethodOptions): - GaxiosPromise; - testIamPermissions( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - testIamPermissions( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions, - callback: BodyResponseCallback): - void; - testIamPermissions( - callback: BodyResponseCallback): - void; - testIamPermissions( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+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$Locations$Datasets$Fhirstores$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the FHIR store that is being created. The string must match the - * following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - */ - fhirStoreId?: string; - /** - * The name of the dataset this FHIR store belongs to. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FhirStore; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The resource name of the FHIR store to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Name of the FHIR store in which this bundle will be executed. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Export - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The FHIR store name to export from. The name should be in the format - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ExportResourcesRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The resource name of the FHIR store to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$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$Locations$Datasets$Fhirstores$Getmetadata - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Name of the FHIR store to retrieve the capabilities for. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Import - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The FHIR store name to import FHIR resources to. The name should be in - * the format - * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ImportResourcesRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Limit on the number of FHIR stores to return in a single response. If - * zero the default page size of 100 is used. - */ - pageSize?: number; - /** - * The next_page_token value returned from the previous List request, if - * any. - */ - pageToken?: string; - /** - * Name of the dataset. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Output only. Resource name of the FHIR store, of the form - * `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - */ - name?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FhirStore; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy - 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 specified. See the - * operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * REQUIRED: The resource for which the policy detail is being requested. - * See the operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Datasets$Fhirstores$Resources { - context: APIRequestContext; - Patient: Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient; - _history: - Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history; - constructor(context: APIRequestContext) { - this.context = context; - this.Patient = - new Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient( - this.context); - this._history = - new Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history( - this.context); - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.resources.conditionalDeleteResource - * @desc Deletes FHIR resources matching a search query. 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 - * GetResourceVersion and related methods, unless they are removed by the - * DeleteResourceVersions method. - * @alias - * healthcare.projects.locations.datasets.fhirStores.resources.conditionalDeleteResource - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The type of the resource to update. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - conditionalDeleteResource( - params?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionaldeleteresource, - options?: MethodOptions): GaxiosPromise; - conditionalDeleteResource( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionaldeleteresource, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - conditionalDeleteResource( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionaldeleteresource, - callback: BodyResponseCallback): void; - conditionalDeleteResource(callback: BodyResponseCallback): - void; - conditionalDeleteResource( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionaldeleteresource| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionaldeleteresource; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionaldeleteresource; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/resources/{+type}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['parent', 'type'], - pathParams: ['parent', 'type'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.resources.conditionalPatchResource - * @desc Updates parts of a resource if the resource exists based on the - * search criteria specified via query parameters. - * @alias - * healthcare.projects.locations.datasets.fhirStores.resources.conditionalPatchResource - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The type of the resource to update. - * @param {().HttpBody} 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 - */ - conditionalPatchResource( - params?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalpatchresource, - options?: MethodOptions): GaxiosPromise; - conditionalPatchResource( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalpatchresource, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - conditionalPatchResource( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalpatchresource, - callback: BodyResponseCallback): void; - conditionalPatchResource(callback: BodyResponseCallback): - void; - conditionalPatchResource( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalpatchresource| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalpatchresource; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalpatchresource; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/resources/{+type}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['parent', 'type'], - pathParams: ['parent', 'type'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.resources.conditionalUpdateResource - * @desc Updates the entire resource if the resource exists based on the - * search criteria specified via query parameters. - * @alias - * healthcare.projects.locations.datasets.fhirStores.resources.conditionalUpdateResource - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The type of the resource to update. - * @param {().HttpBody} 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 - */ - conditionalUpdateResource( - params?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalupdateresource, - options?: MethodOptions): GaxiosPromise; - conditionalUpdateResource( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalupdateresource, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - conditionalUpdateResource( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalupdateresource, - callback: BodyResponseCallback): void; - conditionalUpdateResource(callback: BodyResponseCallback): - void; - conditionalUpdateResource( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalupdateresource| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalupdateresource; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalupdateresource; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/resources/{+type}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['parent', 'type'], - pathParams: ['parent', 'type'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.resources.createResource - * @desc Creates a FHIR resource. - * @alias - * healthcare.projects.locations.datasets.fhirStores.resources.createResource - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The name of the FHIR store this resource belongs to. - * @param {string} params.type The type of the resource to create. - * @param {().HttpBody} 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 - */ - createResource( - params?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Createresource, - options?: MethodOptions): GaxiosPromise; - createResource( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Createresource, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - createResource( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Createresource, - callback: BodyResponseCallback): void; - createResource(callback: BodyResponseCallback): void; - createResource( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Createresource| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Createresource; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Createresource; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/resources/{+type}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent', 'type'], - pathParams: ['parent', 'type'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.resources.delete - * @desc Deletes a FHIR resource. 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 GetResourceVersion and related methods, - * unless they are removed by the DeleteResourceVersions method. - * @alias healthcare.projects.locations.datasets.fhirStores.resources.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the 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$Projects$Locations$Datasets$Fhirstores$Resources$Delete, - options?: MethodOptions): GaxiosPromise; - delete( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.resources.delete$purge - * @desc Deletes all the historical versions of a resource (excluding - * current version) from the FHIR store. To remove all versions of a - * resource, first delete the current version and call this API. - * @alias - * healthcare.projects.locations.datasets.fhirStores.resources.delete$purge - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the resource to purge. - * @param {object} [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$purge( - params?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete$purge, - options?: MethodOptions): GaxiosPromise; - delete$purge( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete$purge, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete$purge( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete$purge, - callback: BodyResponseCallback): void; - delete$purge(callback: BodyResponseCallback): void; - delete$purge( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete$purge| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete$purge; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete$purge; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}/$purge') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.resources.get - * @desc Gets a FHIR resource. - * @alias healthcare.projects.locations.datasets.fhirStores.resources.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the resource 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$Projects$Locations$Datasets$Fhirstores$Resources$Get, - options?: MethodOptions): GaxiosPromise; - get(params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.resources.getMetadata - * @desc Gets the capabilities statement for the store. - * @alias - * healthcare.projects.locations.datasets.fhirStores.resources.getMetadata - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Name of the FHIR store to retrieve the capabilities 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 - */ - getMetadata( - params?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Getmetadata, - options?: MethodOptions): GaxiosPromise; - getMetadata( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Getmetadata, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - getMetadata( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Getmetadata, - callback: BodyResponseCallback): void; - getMetadata(callback: BodyResponseCallback): void; - getMetadata( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Getmetadata| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Getmetadata; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Getmetadata; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}/resources/metadata') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.resources.patch - * @desc Updates part of an existing resource. - * @alias healthcare.projects.locations.datasets.fhirStores.resources.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the resource to update. - * @param {().HttpBody} 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$Datasets$Fhirstores$Resources$Patch, - options?: MethodOptions): GaxiosPromise; - patch( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.resources.searchResources - * @desc Searches resources in the given FHIR store. # Search Parameters - * The server's capability statement, retrieved through - * GetCapabilityStatement, indicates which search parameters are supported - * on each FHIR resource. # 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 - * @alias - * healthcare.projects.locations.datasets.fhirStores.resources.searchResources - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent Name of the FHIR store to retrieve resources from. - * @param {string} params.resourceType The type of the resource to search. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - searchResources( - params?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Searchresources, - options?: MethodOptions): GaxiosPromise; - searchResources( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Searchresources, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - searchResources( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Searchresources, - callback: BodyResponseCallback): void; - searchResources(callback: BodyResponseCallback): void; - searchResources( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Searchresources| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Searchresources; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Searchresources; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/resources/{+resourceType}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent', 'resourceType'], - pathParams: ['parent', 'resourceType'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.resources.update - * @desc Updates the entire resource or creates a new resource with a client - * specified ID if the resource does not exist and the FHIR store has - * enable_update_create set. - * @alias healthcare.projects.locations.datasets.fhirStores.resources.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the resource to update. - * @param {().HttpBody} 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$Projects$Locations$Datasets$Fhirstores$Resources$Update, - options?: MethodOptions): GaxiosPromise; - update( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.resources._search - * @desc Searches resources in the given FHIR store. # Search Parameters - * The server's capability statement, retrieved through - * GetCapabilityStatement, indicates which search parameters are supported - * on each FHIR resource. # 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 - * @alias - * healthcare.projects.locations.datasets.fhirStores.resources._search - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent Name of the FHIR store to retrieve resources from. - * @param {().SearchResourcesRequest} 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 - */ - _search( - params?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_search, - options?: MethodOptions): GaxiosPromise; - _search( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_search, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - _search( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_search, - callback: BodyResponseCallback): void; - _search(callback: BodyResponseCallback): void; - _search( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_search| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_search; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_search; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/resources/_search') - .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$Datasets$Fhirstores$Resources$Conditionaldeleteresource - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of the FHIR store this resource belongs to. - */ - parent?: string; - /** - * The type of the resource to update. - */ - type?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalpatchresource - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of the FHIR store this resource belongs to. - */ - parent?: string; - /** - * The type of the resource to update. - */ - type?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalupdateresource - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of the FHIR store this resource belongs to. - */ - parent?: string; - /** - * The type of the resource to update. - */ - type?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Createresource - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of the FHIR store this resource belongs to. - */ - parent?: string; - /** - * The type of the resource to create. - */ - type?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of the resource to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete$purge - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of the resource to purge. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of the resource to retrieve. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Getmetadata - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Name of the FHIR store to retrieve the capabilities for. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of the resource to update. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Searchresources - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Name of the FHIR store to retrieve resources from. - */ - parent?: string; - /** - * The type of the resource to search. - */ - resourceType?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of the resource to update. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$HttpBody; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_search - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Name of the FHIR store to retrieve resources from. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SearchResourcesRequest; - } - - export class - Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.resources.Patient.get$everything - * @desc Gets all the resources in the patient compartment. - * @alias - * healthcare.projects.locations.datasets.fhirStores.resources.Patient.get$everything - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.end The response includes records prior to the end date. If no end date is provided, all records subsequent to the start date are in scope. - * @param {string} params.name Name of the patient for which the information is required. - * @param {string=} params.start The response includes records subsequent to the start date. If no start date is provided, all records prior to the end date are in scope. - * @param {object} [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$everything( - params?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient$Get$everything, - options?: MethodOptions): GaxiosPromise; - get$everything( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient$Get$everything, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get$everything( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient$Get$everything, - callback: BodyResponseCallback): void; - get$everything(callback: BodyResponseCallback): void; - get$everything( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient$Get$everything| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient$Get$everything; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient$Get$everything; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}/$everything') - .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$Datasets$Fhirstores$Resources$Patient$Get$everything - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The response includes records prior to the end date. If no end date is - * provided, all records subsequent to the start date are in scope. - */ - end?: string; - /** - * Name of the patient for which the information is required. - */ - name?: string; - /** - * The response includes records subsequent to the start date. If no start - * date is provided, all records prior to the end date are in scope. - */ - start?: string; - } - - - export class - Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.resources._history.get - * @desc Gets a version (current or historical) of FHIR resource by version - * id. - * @alias - * healthcare.projects.locations.datasets.fhirStores.resources._history.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the resource version 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$Projects$Locations$Datasets$Fhirstores$Resources$_history$Get, - options?: MethodOptions): GaxiosPromise; - get(params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * healthcare.projects.locations.datasets.fhirStores.resources._history.list - * @desc Lists all the versions of a resource (including the current version - * and deleted versions) from the FHIR store. - * @alias - * healthcare.projects.locations.datasets.fhirStores.resources._history.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.at Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: An entire year: `_at=2019` An entire month: `_at=2019-01` A specific day: `_at=2019-01-20` A specific second: `_at=2018-12-31T23:59:58Z` - * @param {integer=} params.count The maximum number of search results on a page. - * @param {string} params.name The name of the resource to retrieve. - * @param {string=} params.page Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of the `link.url` field returned in the response to the previous request, where `link.relation` is "first", "previous", "next" or "last". Omit `page` if no previous request has been made. - * @param {string=} params.since Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone. - * @param {object} [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$Datasets$Fhirstores$Resources$_history$List, - options?: MethodOptions): GaxiosPromise; - list( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}/_history') - .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$Datasets$Fhirstores$Resources$_history$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of the resource version to retrieve. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Only include resource versions that were current at some point during the - * time period specified in the date time value. The date parameter format - * is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the - * following: An entire year: `_at=2019` An entire month: `_at=2019-01` A - * specific day: `_at=2019-01-20` A specific second: - * `_at=2018-12-31T23:59:58Z` - */ - at?: string; - /** - * The maximum number of search results on a page. - */ - count?: number; - /** - * The name of the resource to retrieve. - */ - name?: string; - /** - * Used to retrieve the first, previous, next, or last page of resource - * versions when using pagination. Value should be set to the value of the - * `link.url` field returned in the response to the previous request, where - * `link.relation` is "first", "previous", "next" or "last". Omit `page` if - * no previous request has been made. - */ - page?: string; - /** - * Only include resource versions that were created at or after the given - * instant in time. The instant in time uses the format - * YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 - * or 2017-01-01T00:00:00Z). The time must be specified to the second and - * include a time zone. - */ - since?: string; - } - - - - export class Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - - /** - * 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 - * @alias - * healthcare.projects.locations.datasets.fhirStores.securityLabels.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$Locations$Datasets$Fhirstores$Securitylabels$Getiampolicy, - options?: MethodOptions): GaxiosPromise; - getIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Getiampolicy, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - getIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Getiampolicy, - callback: BodyResponseCallback): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Getiampolicy| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+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); - } - } - - - /** - * 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 - * @alias - * healthcare.projects.locations.datasets.fhirStores.securityLabels.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$Locations$Datasets$Fhirstores$Securitylabels$Setiampolicy, - options?: MethodOptions): GaxiosPromise; - setIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Setiampolicy, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - setIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Setiampolicy, - callback: BodyResponseCallback): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Setiampolicy| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+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); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$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$Locations$Datasets$Fhirstores$Securitylabels$Setiampolicy - 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 specified. See the - * operation documentation for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - - - - export class Resource$Projects$Locations$Datasets$Hl7v2stores { - context: APIRequestContext; - messages: Resource$Projects$Locations$Datasets$Hl7v2stores$Messages; - constructor(context: APIRequestContext) { - this.context = context; - this.messages = - new Resource$Projects$Locations$Datasets$Hl7v2stores$Messages( - this.context); - } - - - /** - * healthcare.projects.locations.datasets.hl7V2Stores.create - * @desc Creates a new HL7v2 store within the parent dataset. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.hl7V2StoreId The ID of the HL7v2 store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - * @param {string} params.parent The name of the dataset this HL7v2 store belongs to. - * @param {().Hl7V2Store} 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$Datasets$Hl7v2stores$Create, - options?: MethodOptions): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create; - let options = (optionsOrCallback || {}) as MethodOptions; + * A subset of `TestPermissionsRequest.permissions` that the caller is + * allowed. + */ + permissions?: string[]; + } - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create; - options = {}; - } - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/hl7V2Stores') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } + + export class Resource$Projects$Locations { + context: APIRequestContext; + datasets: Resource$Projects$Locations$Datasets; + constructor(context: APIRequestContext) { + this.context = context; + this.datasets = new Resource$Projects$Locations$Datasets(this.context); } /** - * healthcare.projects.locations.datasets.hl7V2Stores.delete - * @desc Deletes the specified HL7v2 store and removes all messages that are - * contained within it. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.delete + * healthcare.projects.locations.get + * @desc Gets information about a location. + * @alias healthcare.projects.locations.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the HL7v2 store to delete. + * @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 */ - delete( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete, - options?: MethodOptions): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete; + 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$Datasets$Hl7v2stores$Delete; + params = {} as Params$Resource$Projects$Locations$Get; options = {}; } @@ -7657,7 +523,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' + method: 'GET' }, options), params, @@ -7666,48 +532,54 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores context: this.context }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * healthcare.projects.locations.datasets.hl7V2Stores.get - * @desc Gets the specified HL7v2 store. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.get + * healthcare.projects.locations.list + * @desc Lists information about the supported locations for this service. + * @alias healthcare.projects.locations.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the HL7v2 store to get. + * @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 */ - get(params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get, - options?: MethodOptions): GaxiosPromise; - get(params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get| - BodyResponseCallback, + 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$Datasets$Hl7v2stores$Get; + 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$Datasets$Hl7v2stores$Get; + params = {} as Params$Resource$Projects$Locations$List; options = {}; } @@ -7720,7 +592,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+name}/locations') + .replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), @@ -7730,198 +603,104 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores context: this.context }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } - + export interface Params$Resource$Projects$Locations$Get extends + StandardParameters { /** - * 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. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.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 {object} [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 client or API Key for the request */ - getIamPolicy( - params?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy, - options?: MethodOptions): GaxiosPromise; - getIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - getIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy, - callback: BodyResponseCallback): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * healthcare.projects.locations.datasets.hl7V2Stores.list - * @desc Lists the HL7v2 stores in the given dataset. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Limit on the number of HL7v2 stores to return in a single response. If zero the default page size of 100 is used. - * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. - * @param {string} params.parent Name of the dataset. - * @param {object} [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 name for the location. */ - list( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List, - options?: MethodOptions): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List; - options = {}; - } + 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; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * 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; + } - const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/hl7V2Stores') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } + export class Resource$Projects$Locations$Datasets { + context: APIRequestContext; + dicomStores: Resource$Projects$Locations$Datasets$Dicomstores; + hl7V2Stores: Resource$Projects$Locations$Datasets$Hl7v2stores; + operations: Resource$Projects$Locations$Datasets$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.dicomStores = + new Resource$Projects$Locations$Datasets$Dicomstores(this.context); + this.hl7V2Stores = + new Resource$Projects$Locations$Datasets$Hl7v2stores(this.context); + this.operations = + new Resource$Projects$Locations$Datasets$Operations(this.context); } /** - * healthcare.projects.locations.datasets.hl7V2Stores.patch - * @desc Updates the HL7v2 store. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.patch + * 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. + * @alias healthcare.projects.locations.datasets.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Output only. Resource name of the HL7v2 store, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. - * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * @param {().Hl7V2Store} params.resource Request body data + * @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. * @return {object} Request object */ - patch( - params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch, - options?: MethodOptions): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( + getIamPolicy( + params?: Params$Resource$Projects$Locations$Datasets$Getiampolicy, + options?: MethodOptions): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { + Params$Resource$Projects$Locations$Datasets$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch; + Params$Resource$Projects$Locations$Datasets$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch; + params = {} as Params$Resource$Projects$Locations$Datasets$Getiampolicy; options = {}; } @@ -7934,28 +713,29 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' + url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' }, options), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy + * healthcare.projects.locations.datasets.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces * any existing policy. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy + * @alias healthcare.projects.locations.datasets.setIamPolicy * @memberOf! () * * @param {object} params Parameters for request @@ -7966,34 +746,30 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores * @return {object} Request object */ setIamPolicy( - params?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy, + params?: Params$Resource$Projects$Locations$Datasets$Setiampolicy, options?: MethodOptions): GaxiosPromise; setIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy, + params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, options: MethodOptions|BodyResponseCallback, callback: BodyResponseCallback): void; setIamPolicy( - params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy, + params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, callback: BodyResponseCallback): void; setIamPolicy(callback: BodyResponseCallback): void; setIamPolicy( paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy| + Params$Resource$Projects$Locations$Datasets$Setiampolicy| BodyResponseCallback, optionsOrCallback?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void|GaxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy; + Params$Resource$Projects$Locations$Datasets$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Datasets$Setiampolicy; options = {}; } @@ -8025,14 +801,13 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores /** - * healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions + * 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. - * @alias - * healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions + * @alias healthcare.projects.locations.datasets.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request @@ -8043,20 +818,17 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores * @return {object} Request object */ testIamPermissions( - params?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions, + params?: Params$Resource$Projects$Locations$Datasets$Testiampermissions, options?: MethodOptions): GaxiosPromise; testIamPermissions( - params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions, + params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, options: MethodOptions| BodyResponseCallback, callback: BodyResponseCallback): void; testIamPermissions( - params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions, + params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, callback: BodyResponseCallback): void; testIamPermissions( @@ -8064,20 +836,20 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores void; testIamPermissions( paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions| + Params$Resource$Projects$Locations$Datasets$Testiampermissions| BodyResponseCallback, optionsOrCallback?: MethodOptions| BodyResponseCallback, callback?: BodyResponseCallback): void|GaxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions; + Params$Resource$Projects$Locations$Datasets$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = {} as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions; + Params$Resource$Projects$Locations$Datasets$Testiampermissions; options = {}; } @@ -8109,53 +881,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores } } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the HL7v2 store that is being created. The string must match - * the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - */ - hl7V2StoreId?: string; - /** - * The name of the dataset this HL7v2 store belongs to. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Hl7V2Store; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The resource name of the HL7v2 store to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The resource name of the HL7v2 store to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy + export interface Params$Resource$Projects$Locations$Datasets$Getiampolicy extends StandardParameters { /** * Auth client or API Key for the request @@ -8168,53 +894,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores */ resource?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Limit on the number of HL7v2 stores to return in a single response. If - * zero the default page size of 100 is used. - */ - pageSize?: number; - /** - * The next_page_token value returned from the previous List request, if - * any. - */ - pageToken?: string; - /** - * Name of the dataset. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Output only. Resource name of the HL7v2 store, of the form - * `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. - */ - name?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Hl7V2Store; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy + export interface Params$Resource$Projects$Locations$Datasets$Setiampolicy extends StandardParameters { /** * Auth client or API Key for the request @@ -8232,7 +912,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores */ requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions + export interface Params$Resource$Projects$Locations$Datasets$Testiampermissions extends StandardParameters { /** * Auth client or API Key for the request @@ -8251,7 +931,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores requestBody?: Schema$TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Datasets$Hl7v2stores$Messages { + export class Resource$Projects$Locations$Datasets$Dicomstores { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -8259,52 +939,47 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores /** - * 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. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.create + * 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. + * @alias healthcare.projects.locations.datasets.dicomStores.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The name of the dataset this message belongs to. - * @param {().CreateMessageRequest} params.resource Request body data + * @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. * @return {object} Request object */ - create( + getIamPolicy( params?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create, - options?: MethodOptions): GaxiosPromise; - create( + Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy, + options?: MethodOptions): GaxiosPromise; + getIamPolicy( params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - create( + Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; - create( + Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { + Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create; + Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = {} as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create; + Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy; options = {}; } @@ -8317,65 +992,67 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/messages') + url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy') .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' + method: 'GET' }, options), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * healthcare.projects.locations.datasets.hl7V2Stores.messages.delete - * @desc Deletes an HL7v2 message. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.delete + * healthcare.projects.locations.datasets.dicomStores.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces + * any existing policy. + * @alias healthcare.projects.locations.datasets.dicomStores.setIamPolicy * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the HL7v2 message to delete. + * @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 */ - delete( + setIamPolicy( params?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete, - options?: MethodOptions): GaxiosPromise; - delete( + Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy, + options?: MethodOptions): GaxiosPromise; + setIamPolicy( params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( + Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( + Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { + Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete; + Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = {} as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete; + Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy; options = {}; } @@ -8388,61 +1065,78 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' + url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' }, options), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * healthcare.projects.locations.datasets.hl7V2Stores.messages.get - * @desc Gets an HL7v2 message. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.get + * 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. + * @alias + * healthcare.projects.locations.datasets.dicomStores.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the HL7v2 message to retrieve. - * @param {string=} params.view Specifies which parts of the Message resource should be returned in the response. + * @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 */ - get(params?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get, - options?: MethodOptions): GaxiosPromise; - get(params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { + testIamPermissions( + params?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions, + options?: MethodOptions): + GaxiosPromise; + testIamPermissions( + params: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + testIamPermissions( + params: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions, + callback: BodyResponseCallback): + void; + testIamPermissions( + callback: BodyResponseCallback): + void; + testIamPermissions( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get; + Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = {} as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get; + Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions; options = {}; } @@ -8455,71 +1149,125 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' + url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' }, options), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$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; + } + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy + 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 specified. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + + export class Resource$Projects$Locations$Datasets$Hl7v2stores { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * 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. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest + * 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. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The name of the HL7v2 store this message belongs to. - * @param {().IngestMessageRequest} params.resource Request body data + * @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. * @return {object} Request object */ - ingest( + getIamPolicy( params?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest, - options?: MethodOptions): GaxiosPromise; - ingest( + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy, + options?: MethodOptions): GaxiosPromise; + getIamPolicy( params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - ingest( + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest, - callback: BodyResponseCallback): void; - ingest(callback: BodyResponseCallback): void; - ingest( + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest; + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = {} as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest; + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy; options = {}; } @@ -8532,72 +1280,67 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/messages:ingest') + url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy') .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' + method: 'GET' }, options), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * healthcare.projects.locations.datasets.hl7V2Stores.messages.list - * @desc Lists all the messages in the given HL7v2 store with support for - * filtering. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.list + * healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces + * any existing policy. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: - message_type, from the MSH-9 segment, e.g. 'NOT message_type = "ADT"' - send_date or sendDate, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment; e.g. 'send_date < "2017-01-02"' - send_time, the timestamp of when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment; e.g. 'send_time < "2017-01-02T00:00:00-05:00"' - send_facility, the hospital/trust that the message came from, from the MSH-4 segment, e.g. 'send_facility = "RAL"' - HL7RegExp(expr), which does regular expression matching of expr against the HL7 message payload using re2 (http://code.google.com/p/re2/) syntax; e.g. 'HL7RegExp("^.*\|.*\|CERNER")' - PatientId(value, type), which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments; e.g. 'PatientId("123456", "MRN")' - HasLabel(x), a boolean returning true if the message has a label with key x (having any value) set using the labels map in Message; e.g. 'HasLabel("priority")' - Label(x), a string value of the label with key x as set using the labels map in Message, e.g. 'Label("priority") = "high"' Negation on the patient ID function and the label function are not supported, e.g. invalid queries: 'NOT PatientId("123456", "MRN")', 'NOT HasLabel("tag1")', 'NOT Label("tag2") = "val2"'. Conjunction of multiple patient ID functions is not supported, e.g. an invalid query: 'PatientId("123456", "MRN") AND PatientId("456789", "MRN")'. Conjunction of multiple label functions is also not supported, e.g. an invalid query: 'HasLabel("tag1") AND Label("tag2") = "val2"'. Conjunction of one patient ID function, one label function and other fields is supported, e.g. a valid query: 'PatientId("123456", "MRN") AND HasLabel("tag1") AND message_type = "ADT"'. - * @param {string=} params.orderBy Orders messages returned by the specified order_by clause. Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order Fields available for ordering are: - send_time - * @param {integer=} params.pageSize Limit on the number of messages to return in a single response. If zero the default page size of 100 is used. - * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. - * @param {string} params.parent Name of the HL7v2 store to retrieve messages from. + * @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 */ - list( + setIamPolicy( params?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List, - options?: MethodOptions): GaxiosPromise; - list( + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy, + options?: MethodOptions): GaxiosPromise; + setIamPolicy( params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List; + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = {} as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List; + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy; options = {}; } @@ -8610,67 +1353,78 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/messages') + url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy') .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' + method: 'POST' }, options), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * healthcare.projects.locations.datasets.hl7V2Stores.messages.patch - * @desc Update the message. - * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.patch + * 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. + * @alias + * healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name 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. - * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask Only the `labels` field is allowed to be updated. The labels in the request will be merged with the existing set of labels. Existing labels with the same keys will be updated. - * @param {().Message} params.resource Request body data + * @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 */ - patch( + testIamPermissions( params?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch, - options?: MethodOptions): GaxiosPromise; - patch( + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions, + options?: MethodOptions): + GaxiosPromise; + testIamPermissions( params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + testIamPermissions( params: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions, + callback: BodyResponseCallback): + void; + testIamPermissions( + callback: BodyResponseCallback): + void; + testIamPermissions( paramsOrCallback?: - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch; + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = {} as - Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch; + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions; options = {}; } @@ -8683,53 +1437,26 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' + url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' }, options), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The name of the dataset this message belongs to. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreateMessageRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The resource name of the HL7v2 message to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy extends StandardParameters { /** * Auth client or API Key for the request @@ -8737,16 +1464,12 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The resource name of the HL7v2 message to retrieve. - */ - name?: string; - /** - * Specifies which parts of the Message resource should be returned in the - * response. + * REQUIRED: The resource for which the policy is being requested. See the + * operation documentation for the appropriate value for this field. */ - view?: string; + resource?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy extends StandardParameters { /** * Auth client or API Key for the request @@ -8754,77 +1477,17 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The name of the HL7v2 store this message belongs to. + * REQUIRED: The resource for which the policy is being specified. See the + * operation documentation for the appropriate value for this field. */ - parent?: string; + resource?: string; /** * Request body metadata */ - requestBody?: Schema$IngestMessageRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Restricts messages returned to those matching a filter. Syntax: - * https://cloud.google.com/appengine/docs/standard/python/search/query_strings - * Fields/functions available for filtering are: - message_type, from the - * MSH-9 segment, e.g. 'NOT message_type = "ADT"' - send_date or sendDate, - * the YYYY-MM-DD date the message was sent in the dataset's time_zone, - * from the MSH-7 segment; e.g. 'send_date < "2017-01-02"' - send_time, - * the timestamp of when the message was sent, using the RFC3339 time - * format for comparisons, from the MSH-7 segment; e.g. 'send_time < - * "2017-01-02T00:00:00-05:00"' - send_facility, the hospital/trust that the - * message came from, from the MSH-4 segment, e.g. 'send_facility = "RAL"' - * - HL7RegExp(expr), which does regular expression matching of expr against - * the HL7 message payload using re2 (http://code.google.com/p/re2/) syntax; - * e.g. 'HL7RegExp("^.*\|.*\|CERNER")' - PatientId(value, type), which - * matches if the message lists a patient having an ID of the given value - * and type in the PID-2, PID-3, or PID-4 segments; e.g. - * 'PatientId("123456", "MRN")' - HasLabel(x), a boolean returning true if - * the message has a label with key x (having any value) set using the - * labels map in Message; e.g. 'HasLabel("priority")' - Label(x), a string - * value of the label with key x as set using the labels map in Message, - * e.g. 'Label("priority") = "high"' Negation on the patient ID function and - * the label function are not supported, e.g. invalid queries: 'NOT - * PatientId("123456", "MRN")', 'NOT HasLabel("tag1")', 'NOT Label("tag2") = - * "val2"'. Conjunction of multiple patient ID functions is not supported, - * e.g. an invalid query: 'PatientId("123456", "MRN") AND - * PatientId("456789", "MRN")'. Conjunction of multiple label functions is - * also not supported, e.g. an invalid query: 'HasLabel("tag1") AND - * Label("tag2") = "val2"'. Conjunction of one patient ID function, one - * label function and other fields is supported, e.g. a valid query: - * 'PatientId("123456", "MRN") AND HasLabel("tag1") AND message_type = - * "ADT"'. - */ - filter?: string; - /** - * Orders messages returned by the specified order_by clause. Syntax: - * https://cloud.google.com/apis/design/design_patterns#sorting_order Fields - * available for ordering are: - send_time - */ - orderBy?: string; - /** - * Limit on the number of messages to return in a single response. If zero - * the default page size of 100 is used. - */ - pageSize?: number; - /** - * The next_page_token value returned from the previous List request, if - * any. - */ - pageToken?: string; - /** - * Name of the HL7v2 store to retrieve messages from. - */ - parent?: string; + requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions extends StandardParameters { /** * Auth client or API Key for the request @@ -8832,29 +1495,18 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * 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?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * Only the `labels` field is allowed to be updated. The labels in the - * request will be merged with the existing set of labels. Existing labels - * with the same keys will be updated. + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. */ - updateMask?: string; + resource?: string; /** * Request body metadata */ - requestBody?: Schema$Message; + requestBody?: Schema$TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Datasets$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/healthcare/v1alpha2.ts b/src/apis/healthcare/v1alpha2.ts index 3d1a7307035..f0bd9d50fb9 100644 --- a/src/apis/healthcare/v1alpha2.ts +++ b/src/apis/healthcare/v1alpha2.ts @@ -223,7 +223,7 @@ export namespace healthcare_v1alpha2 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ @@ -901,8 +901,8 @@ export namespace healthcare_v1alpha2 { * = 1; // The raw HTTP body is bound to this field. * google.api.HttpBody http_body = 2; } service ResourceService { rpc * GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - * UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - * Example with streaming methods: service CaldavService { rpc + * UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); + * } Example with streaming methods: service CaldavService { rpc * GetCalendar(stream google.api.HttpBody) returns (stream * google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) * returns (stream google.api.HttpBody); } Use of this type only changes diff --git a/src/apis/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index f52a0beab4a..9300e325856 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -166,7 +166,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ @@ -788,8 +788,8 @@ export namespace healthcare_v1beta1 { * = 1; // The raw HTTP body is bound to this field. * google.api.HttpBody http_body = 2; } service ResourceService { rpc * GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - * UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - * Example with streaming methods: service CaldavService { rpc + * UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); + * } Example with streaming methods: service CaldavService { rpc * GetCalendar(stream google.api.HttpBody) returns (stream * google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) * returns (stream google.api.HttpBody); } Use of this type only changes diff --git a/src/apis/iap/v1.ts b/src/apis/iap/v1.ts index 7e250c481ad..c7e55bfcc8c 100644 --- a/src/apis/iap/v1.ts +++ b/src/apis/iap/v1.ts @@ -111,7 +111,7 @@ export namespace iap_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/iap/v1beta1.ts b/src/apis/iap/v1beta1.ts index 1ae7b86aa16..e6902be19fd 100644 --- a/src/apis/iap/v1beta1.ts +++ b/src/apis/iap/v1beta1.ts @@ -111,7 +111,7 @@ export namespace iap_v1beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/index.ts b/src/apis/index.ts index 654f2f076cf..8a26dce7d9f 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -15,6 +15,7 @@ import * as abusiveexperiencereport from './abusiveexperiencereport'; import * as acceleratedmobilepageurl from './acceleratedmobilepageurl'; +import * as accessapproval from './accessapproval'; import * as accesscontextmanager from './accesscontextmanager'; import * as adexchangebuyer from './adexchangebuyer'; import * as adexchangebuyer2 from './adexchangebuyer2'; @@ -60,6 +61,7 @@ import * as cloudsearch from './cloudsearch'; import * as cloudshell from './cloudshell'; import * as cloudtasks from './cloudtasks'; import * as cloudtrace from './cloudtrace'; +import * as commentanalyzer from './commentanalyzer'; import * as composer from './composer'; import * as compute from './compute'; import * as container from './container'; @@ -175,6 +177,7 @@ export interface APIList { export const APIS: APIList = { abusiveexperiencereport: abusiveexperiencereport.VERSIONS, acceleratedmobilepageurl: acceleratedmobilepageurl.VERSIONS, + accessapproval: accessapproval.VERSIONS, accesscontextmanager: accesscontextmanager.VERSIONS, adexchangebuyer: adexchangebuyer.VERSIONS, adexchangebuyer2: adexchangebuyer2.VERSIONS, @@ -220,6 +223,7 @@ export const APIS: APIList = { cloudshell: cloudshell.VERSIONS, cloudtasks: cloudtasks.VERSIONS, cloudtrace: cloudtrace.VERSIONS, + commentanalyzer: commentanalyzer.VERSIONS, composer: composer.VERSIONS, compute: compute.VERSIONS, container: container.VERSIONS, @@ -331,6 +335,7 @@ export const APIS: APIList = { export class GeneratedAPIs { abusiveexperiencereport = abusiveexperiencereport.abusiveexperiencereport; acceleratedmobilepageurl = acceleratedmobilepageurl.acceleratedmobilepageurl; + accessapproval = accessapproval.accessapproval; accesscontextmanager = accesscontextmanager.accesscontextmanager; adexchangebuyer = adexchangebuyer.adexchangebuyer; adexchangebuyer2 = adexchangebuyer2.adexchangebuyer2; @@ -378,6 +383,7 @@ export class GeneratedAPIs { cloudshell = cloudshell.cloudshell; cloudtasks = cloudtasks.cloudtasks; cloudtrace = cloudtrace.cloudtrace; + commentanalyzer = commentanalyzer.commentanalyzer; composer = composer.composer; compute = compute.compute; container = container.container; diff --git a/src/apis/jobs/v3.ts b/src/apis/jobs/v3.ts index cdcb284e5e4..07f81f8780c 100644 --- a/src/apis/jobs/v3.ts +++ b/src/apis/jobs/v3.ts @@ -225,11 +225,15 @@ export namespace jobs_v3 { */ export interface Schema$CommuteFilter { /** - * Optional. If `true`, jobs without street level addresses may also be - * returned. For city level addresses, the city center is used. For state - * and coarser level addresses, text matching is used. If this field is set - * to `false` or is not specified, only jobs that include street level - * addresses will be returned by commute search. + * Optional. If true, jobs without "precise" addresses (street + * level addresses or GPS coordinates) might also be returned. For city and + * coarser level addresses, text matching is used. If this field is set to + * false or is not specified, only jobs that include precise addresses are + * returned by Commute Search. Note: If `allow_imprecise_addresses` is set + * to true, Commute Search is not able to calculate accurate commute times + * to jobs with city level and coarser address information. Jobs with + * imprecise addresses will return a `travel_duration` time of 0 regardless + * of distance from the job seeker. */ allowImpreciseAddresses?: boolean; /** @@ -1924,7 +1928,7 @@ export namespace jobs_v3 { * application that uses Cloud Talent Solution. You may inspect the created * events in [self service * tools](https://console.cloud.google.com/talent-solution/overview). [Learn - * more](https://cloud.google.com/talent-solution/job-search/docs/management-tools) + * more](https://cloud.google.com/talent-solution/docs/management-tools) * about self service tools. * @alias jobs.projects.clientEvents.create * @memberOf! () diff --git a/src/apis/jobs/v3p1beta1.ts b/src/apis/jobs/v3p1beta1.ts index c43a2562551..8dfb0683af5 100644 --- a/src/apis/jobs/v3p1beta1.ts +++ b/src/apis/jobs/v3p1beta1.ts @@ -225,11 +225,15 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$CommuteFilter { /** - * Optional. If `true`, jobs without street level addresses may also be - * returned. For city level addresses, the city center is used. For state - * and coarser level addresses, text matching is used. If this field is set - * to `false` or is not specified, only jobs that include street level - * addresses will be returned by commute search. + * Optional. If true, jobs without "precise" addresses (street + * level addresses or GPS coordinates) might also be returned. For city and + * coarser level addresses, text matching is used. If this field is set to + * false or is not specified, only jobs that include precise addresses are + * returned by Commute Search. Note: If `allow_imprecise_addresses` is set + * to true, Commute Search is not able to calculate accurate commute times + * to jobs with city level and coarser address information. Jobs with + * imprecise addresses will return a `travel_duration` time of 0 regardless + * of distance from the job seeker. */ allowImpreciseAddresses?: boolean; /** @@ -2172,7 +2176,7 @@ export namespace jobs_v3p1beta1 { * application that uses Cloud Talent Solution. You may inspect the created * events in [self service * tools](https://console.cloud.google.com/talent-solution/overview). [Learn - * more](https://cloud.google.com/talent-solution/job-search/docs/management-tools) + * more](https://cloud.google.com/talent-solution/docs/management-tools) * about self service tools. * @alias jobs.projects.clientEvents.create * @memberOf! () diff --git a/src/apis/language/v1.ts b/src/apis/language/v1.ts index 46c40c407bc..9517fabf96f 100644 --- a/src/apis/language/v1.ts +++ b/src/apis/language/v1.ts @@ -380,9 +380,10 @@ export namespace language_v1 { */ mentions?: Schema$EntityMention[]; /** - * Metadata associated with the entity. Currently, Wikipedia URLs and - * Knowledge Graph MIDs are provided, if available. The associated keys are - * "wikipedia_url" and "mid", respectively. + * Metadata associated with the entity. For most entity types, the metadata + * is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if + * they are available. For the metadata associated with other entity types, + * see the Type table below. */ metadata?: {[key: string]: string;}; /** diff --git a/src/apis/language/v1beta2.ts b/src/apis/language/v1beta2.ts index 66a5fb01ad6..12e9851e802 100644 --- a/src/apis/language/v1beta2.ts +++ b/src/apis/language/v1beta2.ts @@ -379,9 +379,10 @@ export namespace language_v1beta2 { */ mentions?: Schema$EntityMention[]; /** - * Metadata associated with the entity. Currently, Wikipedia URLs and - * Knowledge Graph MIDs are provided, if available. The associated keys are - * "wikipedia_url" and "mid", respectively. + * Metadata associated with the entity. For most entity types, the metadata + * is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if + * they are available. For the metadata associated with other entity types, + * see the Type table below. */ metadata?: {[key: string]: string;}; /** diff --git a/src/apis/logging/index.ts b/src/apis/logging/index.ts index d9964bb90a4..e3baed78bee 100644 --- a/src/apis/logging/index.ts +++ b/src/apis/logging/index.ts @@ -15,22 +15,15 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {logging_v2} from './v2'; -import {logging_v2beta1} from './v2beta1'; export const VERSIONS = { 'v2': logging_v2.Logging, - 'v2beta1': logging_v2beta1.Logging, }; export function logging(version: 'v2'): logging_v2.Logging; export function logging(options: logging_v2.Options): logging_v2.Logging; -export function logging(version: 'v2beta1'): logging_v2beta1.Logging; -export function logging(options: logging_v2beta1.Options): - logging_v2beta1.Logging; -export function logging( - this: GoogleConfigurable, - versionOrOptions: 'v2'|logging_v2.Options|'v2beta1'| - logging_v2beta1.Options) { +export function logging( + this: GoogleConfigurable, versionOrOptions: 'v2'|logging_v2.Options) { return getAPI('logging', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/logging/v2beta1.ts b/src/apis/logging/v2beta1.ts deleted file mode 100644 index 1ff0fe0a7ba..00000000000 --- a/src/apis/logging/v2beta1.ts +++ /dev/null @@ -1,3301 +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 {GaxiosPromise} from 'gaxios'; -import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; -import {APIRequestContext, BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; - -// tslint:disable: no-any -// tslint:disable: class-name -// tslint:disable: variable-name -// tslint:disable: jsdoc-format -// tslint:disable: no-namespace - -export namespace logging_v2beta1 { - export interface Options extends GlobalOptions { - version: 'v2beta1'; - } - - 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; - } - - /** - * Stackdriver Logging API - * - * Writes log entries and manages your Logging configuration. - * - * @example - * const {google} = require('googleapis'); - * const logging = google.logging('v2beta1'); - * - * @namespace logging - * @type {Function} - * @version v2beta1 - * @variation v2beta1 - * @param {object=} options Options for Logging - */ - export class Logging { - context: APIRequestContext; - entries: Resource$Entries; - monitoredResourceDescriptors: Resource$Monitoredresourcedescriptors; - projects: Resource$Projects; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = {_options: options || {}, google}; - - this.entries = new Resource$Entries(this.context); - this.monitoredResourceDescriptors = - new Resource$Monitoredresourcedescriptors(this.context); - this.projects = new Resource$Projects(this.context); - } - } - - /** - * BucketOptions describes the bucket boundaries used to create a histogram - * for the distribution. The buckets can be in a linear sequence, an - * exponential sequence, or each bucket can be specified explicitly. - * BucketOptions does not include the number of values in each bucket.A bucket - * has an inclusive lower bound and exclusive upper bound for the values that - * are counted for that bucket. The upper bound of a bucket must be strictly - * greater than the lower bound. The sequence of N buckets for a distribution - * consists of an underflow bucket (number 0), zero or more finite buckets - * (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets - * are contiguous: the lower bound of bucket i (i > 0) is the same as the - * upper bound of bucket i - 1. The buckets span the whole range of finite - * values: lower bound of the underflow bucket is -infinity and the upper - * bound of the overflow bucket is +infinity. The finite buckets are so-called - * because both bounds are finite. - */ - export interface Schema$BucketOptions { - /** - * The explicit buckets. - */ - explicitBuckets?: Schema$Explicit; - /** - * The exponential buckets. - */ - exponentialBuckets?: Schema$Exponential; - /** - * The linear bucket. - */ - linearBuckets?: Schema$Linear; - } - /** - * 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 {} - /** - * Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 - * (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i - * < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds - * field must contain at least one element. If bounds has only one element, - * then there are no finite buckets, and that single element is the common - * boundary of the overflow and underflow buckets. - */ - export interface Schema$Explicit { - /** - * The values must be monotonically increasing. - */ - bounds?: number[]; - } - /** - * Specifies an exponential sequence of buckets that have a width that is - * proportional to the value of the lower bound. Each bucket represents a - * constant relative uncertainty on a specific value in the bucket.There are - * num_finite_buckets + 2 (= N) buckets. Bucket i has the following - * boundaries:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). - * Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). - */ - export interface Schema$Exponential { - /** - * Must be greater than 1. - */ - growthFactor?: number; - /** - * Must be greater than 0. - */ - numFiniteBuckets?: number; - /** - * Must be greater than 0. - */ - scale?: number; - } - /** - * A common proto for logging HTTP requests. Only contains semantics defined - * by the HTTP specification. Product-specific logging information MUST be - * defined in a separate message. - */ - export interface Schema$HttpRequest { - /** - * The number of HTTP response bytes inserted into cache. Set only when a - * cache fill was attempted. - */ - cacheFillBytes?: string; - /** - * Whether or not an entity was served from cache (with or without - * validation). - */ - cacheHit?: boolean; - /** - * Whether or not a cache lookup was attempted. - */ - cacheLookup?: boolean; - /** - * Whether or not the response was validated with the origin server before - * being served from cache. This field is only meaningful if cache_hit is - * True. - */ - cacheValidatedWithOriginServer?: boolean; - /** - * The request processing latency on the server, from the time the request - * was received until the response was sent. - */ - latency?: string; - /** - * Protocol used for the request. Examples: "HTTP/1.1", - * "HTTP/2", "websocket" - */ - protocol?: string; - /** - * The referer URL of the request, as defined in HTTP/1.1 Header Field - * Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). - */ - referer?: string; - /** - * The IP address (IPv4 or IPv6) of the client that issued the HTTP request. - * Examples: "192.168.1.1", "FE80::0202:B3FF:FE1E:8329". - */ - remoteIp?: string; - /** - * The request method. Examples: "GET", "HEAD", - * "PUT", "POST". - */ - requestMethod?: string; - /** - * The size of the HTTP request message in bytes, including the request - * headers and the request body. - */ - requestSize?: string; - /** - * The scheme (http, https), the host name, the path and the query portion - * of the URL that was requested. Example: - * "http://example.com/some/info?color=red". - */ - requestUrl?: string; - /** - * The size of the HTTP response message sent back to the client, in bytes, - * including the response headers and the response body. - */ - responseSize?: string; - /** - * The IP address (IPv4 or IPv6) of the origin server that the request was - * sent to. - */ - serverIp?: string; - /** - * The response code indicating the status of response. Examples: 200, 404. - */ - status?: number; - /** - * The user agent sent by the client. Example: "Mozilla/4.0 - * (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)". - */ - userAgent?: string; - } - /** - * A description of a label. - */ - export interface Schema$LabelDescriptor { - /** - * A human-readable description for the label. - */ - description?: string; - /** - * The label key. - */ - key?: string; - /** - * The type of data that can be assigned to the label. - */ - valueType?: string; - } - /** - * Specifies a linear sequence of buckets that all have the same width (except - * overflow and underflow). Each bucket represents a constant absolute - * uncertainty on the specific value in the bucket.There are - * num_finite_buckets + 2 (= N) buckets. Bucket i has the following - * boundaries:Upper bound (0 <= i < N-1): offset + (width * i). Lower - * bound (1 <= i < N): offset + (width * (i - 1)). - */ - export interface Schema$Linear { - /** - * Must be greater than 0. - */ - numFiniteBuckets?: number; - /** - * Lower bound of the first bucket. - */ - offset?: number; - /** - * Must be greater than 0. - */ - width?: number; - } - /** - * The parameters to ListLogEntries. - */ - export interface Schema$ListLogEntriesRequest { - /** - * Optional. A filter that chooses which log entries to return. See Advanced - * Logs Filters. Only log entries that match the filter are returned. An - * empty filter matches all log entries in the resources listed in - * resource_names. Referencing a parent resource that is not listed in - * resource_names will cause the filter to return no results. The maximum - * length of the filter is 20000 characters. - */ - filter?: string; - /** - * Optional. How the results should be sorted. Presently, the only permitted - * values are "timestamp asc" (default) and "timestamp - * desc". The first option returns entries in order of increasing - * values of LogEntry.timestamp (oldest first), and the second option - * returns entries in order of decreasing timestamps (newest first). Entries - * with equal timestamps are returned in order of their insert_id values. - */ - orderBy?: string; - /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of next_page_token in the - * response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. page_token must be the value of - * next_page_token from the previous response. The values of other method - * parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Deprecated. Use resource_names instead. One or more project identifiers - * or project numbers from which to retrieve log entries. Example: - * "my-project-1A". - */ - projectIds?: string[]; - /** - * Required. Names of one or more parent resources from which to retrieve - * log entries: "projects/[PROJECT_ID]" - * "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" - * "folders/[FOLDER_ID]" Projects listed in the project_ids field - * are added to this list. - */ - resourceNames?: string[]; - } - /** - * Result returned from ListLogEntries. - */ - export interface Schema$ListLogEntriesResponse { - /** - * A list of log entries. If entries is empty, nextPageToken may still be - * returned, indicating that more entries may exist. See nextPageToken for - * more information. - */ - entries?: Schema$LogEntry[]; - /** - * If there might be more results than those appearing in this response, - * then nextPageToken is included. To get the next set of results, call this - * method again using the value of nextPageToken as pageToken.If a value for - * next_page_token appears and the entries field is empty, it means that the - * search found no log entries so far but it did not have time to search all - * the possible log entries. Retry the method with this value for page_token - * to continue the search. Alternatively, consider speeding up the search by - * changing your filter to specify a single log name or resource type, or to - * narrow the time range of the search. - */ - nextPageToken?: string; - } - /** - * Result returned from ListLogMetrics. - */ - export interface Schema$ListLogMetricsResponse { - /** - * A list of logs-based metrics. - */ - metrics?: Schema$LogMetric[]; - /** - * If there might be more results than appear in this response, then - * nextPageToken is included. To get the next set of results, call this - * method again using the value of nextPageToken as pageToken. - */ - nextPageToken?: string; - } - /** - * Result returned from ListMonitoredResourceDescriptors. - */ - export interface Schema$ListMonitoredResourceDescriptorsResponse { - /** - * If there might be more results than those appearing in this response, - * then nextPageToken is included. To get the next set of results, call this - * method again using the value of nextPageToken as pageToken. - */ - nextPageToken?: string; - /** - * A list of resource descriptors. - */ - resourceDescriptors?: Schema$MonitoredResourceDescriptor[]; - } - /** - * Result returned from ListSinks. - */ - export interface Schema$ListSinksResponse { - /** - * If there might be more results than appear in this response, then - * nextPageToken is included. To get the next set of results, call the same - * method again using the value of nextPageToken as pageToken. - */ - nextPageToken?: string; - /** - * A list of sinks. - */ - sinks?: Schema$LogSink[]; - } - /** - * An individual entry in a log. - */ - export interface Schema$LogEntry { - /** - * Optional. Information about the HTTP request associated with this log - * entry, if applicable. - */ - httpRequest?: Schema$HttpRequest; - /** - * Optional. A unique identifier for the log entry. If you provide a value, - * then Logging considers other log entries in the same project, with the - * same timestamp, and with the same insert_id to be duplicates which can be - * removed. If omitted in new log entries, then Logging assigns its own - * unique identifier. The insert_id is also used to order log entries that - * have the same timestamp value. - */ - insertId?: string; - /** - * The log entry payload, represented as a structure that is expressed as a - * JSON object. - */ - jsonPayload?: {[key: string]: any;}; - /** - * Optional. A set of user-defined (key, value) data that provides - * additional information about the log entry. - */ - labels?: {[key: string]: string;}; - /** - * Required. The resource name of the log to which this log entry belongs: - * "projects/[PROJECT_ID]/logs/[LOG_ID]" - * "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - * "folders/[FOLDER_ID]/logs/[LOG_ID]" A project number may - * optionally be used in place of PROJECT_ID. The project number is - * translated to its corresponding PROJECT_ID internally and the log_name - * field will contain PROJECT_ID in queries and exports.[LOG_ID] must be - * URL-encoded within log_name. Example: - * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - * [LOG_ID] must be less than 512 characters long and can only include the - * following characters: upper and lower case alphanumeric characters, - * forward-slash, underscore, hyphen, and period.For backward compatibility, - * if log_name begins with a forward-slash, such as /projects/..., then the - * log entry is ingested as usual but the forward-slash is removed. Listing - * the log entry will not show the leading slash and filtering for a log - * name with a leading slash will never return any results. - */ - logName?: string; - /** - * Deprecated. Output only. Additional metadata about the monitored - * resource.Only k8s_container, k8s_pod, and k8s_node MonitoredResources - * have this field populated for GKE versions older than 1.12.6. For GKE - * versions 1.12.6 and above, the metadata field has been deprecated. The - * Kubernetes pod labels that used to be in metadata.userLabels will now be - * present in the labels field with a key prefix of k8s-pod/. The - * Stackdriver system labels that were present in the metadata.systemLabels - * field will no longer be available in the LogEntry. - */ - metadata?: Schema$MonitoredResourceMetadata; - /** - * Optional. Information about an operation associated with the log entry, - * if applicable. - */ - 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. - */ - protoPayload?: {[key: string]: any;}; - /** - * Output only. The time the log entry was received by Logging. - */ - 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. - */ - resource?: Schema$MonitoredResource; - /** - * Optional. The severity of the log entry. The default value is - * LogSeverity.DEFAULT. - */ - severity?: string; - /** - * Optional. Source code location information associated with the log entry, - * if any. - */ - sourceLocation?: Schema$LogEntrySourceLocation; - /** - * Optional. The span ID within the trace associated with the log entry.For - * Trace spans, this is the same format that the Trace API v2 uses: a - * 16-character hexadecimal encoding of an 8-byte array, such as - * <code>"000000000000004a"</code>. - */ - spanId?: string; - /** - * The log entry payload, represented as a Unicode string (UTF-8). - */ - textPayload?: string; - /** - * Optional. The time the event described by the log entry occurred. This - * time is used to compute the log entry's age and to enforce the logs - * retention period. If this field is omitted in a new log entry, then - * Logging assigns it the current time. Timestamps have nanosecond accuracy, - * but trailing zeros in the fractional seconds might be omitted when the - * timestamp is displayed.Incoming log entries should have timestamps that - * are no more than the logs retention period in the past, and no more than - * 24 hours in the future. Log entries outside those time boundaries will - * not be available when calling entries.list, but those log entries can - * still be exported with LogSinks. - */ - timestamp?: string; - /** - * Optional. Resource name of the trace associated with the log entry, if - * any. If it contains a relative resource name, the name is assumed to be - * relative to //tracing.googleapis.com. Example: - * projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824 - */ - trace?: string; - /** - * Optional. The sampling decision of the trace associated with the log - * entry.True means that the trace resource name in the trace field was - * sampled for storage in a trace backend. False means that the trace was - * not sampled for storage when this log entry was written, or the sampling - * decision was unknown at the time. A non-sampled trace value is still - * useful as a request correlation identifier. The default is False. - */ - traceSampled?: boolean; - } - /** - * Additional information about a potentially long-running operation with - * which a log entry is associated. - */ - export interface Schema$LogEntryOperation { - /** - * Optional. Set this to True if this is the first log entry in the - * operation. - */ - first?: boolean; - /** - * Optional. An arbitrary operation identifier. Log entries with the same - * identifier are assumed to be part of the same operation. - */ - id?: string; - /** - * Optional. Set this to True if this is the last log entry in the - * operation. - */ - last?: boolean; - /** - * Optional. An arbitrary producer identifier. The combination of id and - * producer must be globally unique. Examples for producer: - * "MyDivision.MyBigCompany.com", - * "github.com/MyProject/MyApplication". - */ - producer?: string; - } - /** - * Additional information about the source code location that produced the log - * entry. - */ - export interface Schema$LogEntrySourceLocation { - /** - * Optional. Source file name. Depending on the runtime environment, this - * might be a simple name or a fully-qualified name. - */ - file?: string; - /** - * Optional. Human-readable name of the function or method being invoked, - * with optional context such as the class or package name. This information - * may be used in contexts such as the logs viewer, where a file and line - * number are less meaningful. The format can vary by language. For example: - * qual.if.ied.Class.method (Java), dir/package.func (Go), function - * (Python). - */ - function?: string; - /** - * Optional. Line within the source file. 1-based; 0 indicates no line - * number available. - */ - line?: string; - } - /** - * Application log line emitted while processing a request. - */ - export interface Schema$LogLine { - /** - * App-provided log message. - */ - logMessage?: string; - /** - * Severity of this log entry. - */ - severity?: string; - /** - * Where in the source code this log message was written. - */ - sourceLocation?: Schema$SourceLocation; - /** - * Approximate time when this log entry was made. - */ - time?: string; - } - /** - * Describes a logs-based metric. The value of the metric is the number of log - * entries that match a logs filter in a given time interval.Logs-based metric - * can also be used to extract values from logs and create a a distribution of - * the values. The distribution records the statistics of the extracted values - * along with an optional histogram of the values as specified by the bucket - * options. - */ - export interface Schema$LogMetric { - /** - * Optional. The bucket_options are required when the logs-based metric is - * using a DISTRIBUTION value type and it describes the bucket boundaries - * used to create a histogram of the extracted values. - */ - bucketOptions?: Schema$BucketOptions; - /** - * Output only. The creation timestamp of the metric.This field may not be - * present for older metrics. - */ - createTime?: string; - /** - * Optional. A description of this metric, which is used in documentation. - * The maximum length of the description is 8000 characters. - */ - description?: string; - /** - * Required. An advanced logs filter which is used to match log entries. - * Example: "resource.type=gae_app AND severity>=ERROR" The - * maximum length of the filter is 20000 characters. - */ - filter?: string; - /** - * Optional. A map from a label key string to an extractor expression which - * is used to extract data from a log entry field and assign as the label - * value. Each label key specified in the LabelDescriptor must have an - * associated extractor expression in this map. The syntax of the extractor - * expression is the same as for the value_extractor field.The extracted - * value is converted to the type defined in the label descriptor. If the - * either the extraction or the type conversion fails, the label will have a - * default value. The default value for a string label is an empty string, - * for an integer label its 0, and for a boolean label its false.Note that - * there are upper bounds on the maximum number of labels and the number of - * active time series that are allowed in a project. - */ - labelExtractors?: {[key: string]: string;}; - /** - * Optional. The metric descriptor associated with the logs-based metric. If - * unspecified, it uses a default metric descriptor with a DELTA metric - * kind, INT64 value type, with no labels and a unit of "1". Such - * a metric counts the number of log entries matching the filter - * expression.The name, type, and description fields in the - * metric_descriptor are output only, and is constructed using the name and - * description field in the LogMetric.To create a logs-based metric that - * records a distribution of log values, a DELTA metric kind with a - * DISTRIBUTION value type must be used along with a value_extractor - * expression in the LogMetric.Each label in the metric descriptor must have - * a matching label name as the key and an extractor expression as the value - * in the label_extractors map.The metric_kind and value_type fields in the - * metric_descriptor cannot be updated once initially configured. New labels - * can be added in the metric_descriptor, but existing labels cannot be - * modified except for their description. - */ - metricDescriptor?: Schema$MetricDescriptor; - /** - * Required. The client-assigned metric identifier. Examples: - * "error_count", "nginx/requests".Metric identifiers - * are limited to 100 characters and can include only the following - * characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. - * The forward-slash character (/) denotes a hierarchy of name pieces, and - * it cannot be the first character of the name.The metric identifier in - * this field must not be URL-encoded - * (https://en.wikipedia.org/wiki/Percent-encoding). However, when the - * metric identifier appears as the [METRIC_ID] part of a metric_name API - * parameter, then the metric identifier must be URL-encoded. Example: - * "projects/my-project/metrics/nginx%2Frequests". - */ - name?: string; - /** - * Output only. The last update timestamp of the metric.This field may not - * be present for older metrics. - */ - updateTime?: string; - /** - * Optional. A value_extractor is required when using a distribution - * logs-based metric to extract the values to record from a log entry. Two - * functions are supported for value extraction: EXTRACT(field) or - * REGEXP_EXTRACT(field, regex). The argument are: 1. field: The name of - * the log entry field from which the value is to be extracted. 2. regex: - * A regular expression using the Google RE2 syntax - * (https://github.com/google/re2/wiki/Syntax) with a single capture group - * to extract data from the specified log entry field. The value of the - * field is converted to a string before applying the regex. It is an error - * to specify a regex that does not include exactly one capture group.The - * result of the extraction must be convertible to a double type, as the - * distribution always records double values. If either the extraction or - * the conversion to double fails, then those values are not recorded in the - * distribution.Example: REGEXP_EXTRACT(jsonPayload.request, - * ".*quantity=(\d+).*") - */ - valueExtractor?: string; - /** - * Deprecated. The API version that created or updated this metric. The v2 - * format is used by default and cannot be changed. - */ - version?: string; - } - /** - * Describes a sink used to export log entries to one of the following - * destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or - * a Cloud Pub/Sub topic. A logs filter controls which log entries are - * exported. The sink must be created within a project, organization, billing - * account, or folder. - */ - export interface Schema$LogSink { - /** - * Output only. The creation timestamp of the sink.This field may not be - * present for older sinks. - */ - createTime?: string; - /** - * Required. The export destination: - * "storage.googleapis.com/[GCS_BUCKET]" - * "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" - * "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" - * The sink's writer_identity, set when the sink is created, must have - * permission to write to the destination or else the log entries are not - * exported. For more information, see Exporting Logs with Sinks. - */ - destination?: string; - /** - * Optional. An advanced logs filter. The only exported log entries are - * those that are in the resource owning the sink and that match the filter. - * For example: logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND - * severity>=ERROR - */ - filter?: string; - /** - * Optional. This field applies only to sinks owned by organizations and - * folders. If the field is false, the default, only the logs owned by the - * sink's parent resource are available for export. If the field is - * true, then logs from all the projects, folders, and billing accounts - * contained in the sink's parent resource are also available for - * export. Whether a particular log entry from the children is exported - * depends on the sink's filter expression. For example, if this field - * is true, then the filter resource.type=gce_instance would export all - * Compute Engine VM instance log entries from all projects in the - * sink's parent. To only export entries from certain child projects, - * filter on the project part of the log name: - * logName:("projects/test-project1/" OR - * "projects/test-project2/") AND resource.type=gce_instance - */ - includeChildren?: boolean; - /** - * Required. The client-assigned sink identifier, unique within the project. - * Example: "my-syslog-errors-to-pubsub". Sink identifiers are - * limited to 100 characters and can include only the following characters: - * upper and lower-case alphanumeric characters, underscores, hyphens, and - * periods. - */ - name?: string; - /** - * Deprecated. The log entry format to use for this sink's exported log - * entries. The v2 format is used by default and cannot be changed. - */ - outputVersionFormat?: string; - /** - * Output only. The last update timestamp of the sink.This field may not be - * present for older sinks. - */ - updateTime?: string; - /** - * Output only. An IAM identity&mdash;a service account or - * group&mdash;under which Logging writes the exported log entries to - * the sink's destination. This field is set by sinks.create and - * sinks.update based on the value of unique_writer_identity in those - * methods.Until you grant this identity write-access to the destination, - * log entry exports from this sink will fail. For more information, see - * Granting Access for a Resource. Consult the destination service's - * documentation to determine the appropriate IAM roles to assign to the - * identity. - */ - writerIdentity?: string; - } - /** - * Defines a metric type and its schema. Once a metric descriptor is created, - * deleting or altering it stops data collection and makes the metric - * type's existing data unusable. - */ - export interface Schema$MetricDescriptor { - /** - * A detailed description of the metric, which can be used in documentation. - */ - description?: string; - /** - * A concise name for the metric, which can be displayed in user interfaces. - * Use sentence case without an ending period, for example "Request - * count". This field is optional but it is recommended to be set for - * any metrics associated with user-visible concepts, such as Quota. - */ - displayName?: string; - /** - * The set of labels that can be used to describe a specific instance of - * this metric type. For example, the - * appengine.googleapis.com/http/server/response_latencies metric type has a - * label for the HTTP response code, response_code, so you can look at - * latencies for successful responses or just for responses that failed. - */ - labels?: Schema$LabelDescriptor[]; - /** - * Optional. Metadata which can be used to guide usage of the metric. - */ - metadata?: Schema$MetricDescriptorMetadata; - /** - * Whether the metric records instantaneous values, changes to a value, etc. - * Some combinations of metric_kind and value_type might not be supported. - */ - metricKind?: string; - /** - * The resource name of the metric descriptor. - */ - name?: string; - /** - * The metric type, including its DNS name prefix. The type is not - * URL-encoded. All user-defined metric types have the DNS name - * custom.googleapis.com or external.googleapis.com. Metric types should use - * a natural hierarchical grouping. For example: - * "custom.googleapis.com/invoice/paid/amount" - * "external.googleapis.com/prometheus/up" - * "appengine.googleapis.com/http/server/response_latencies" - */ - type?: string; - /** - * The unit in which the metric value is reported. It is only applicable if - * the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are - * a subset of The Unified Code for Units of Measure - * (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit - * By byte s second min minute h hour d dayPrefixes (PREFIX) k kilo (10**3) - * M mega (10**6) G giga (10**9) T tera (10**12) P peta (10**15) E exa - * (10**18) Z zetta (10**21) Y yotta (10**24) m milli (10**-3) u micro - * (10**-6) n nano (10**-9) p pico (10**-12) f femto (10**-15) a atto - * (10**-18) z zepto (10**-21) y yocto (10**-24) Ki kibi (2**10) Mi mebi - * (2**20) Gi gibi (2**30) Ti tebi (2**40)GrammarThe grammar also includes - * these connectors: / division (as an infix operator, e.g. 1/s). . - * multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit - * is as follows: Expression = Component { "." Component } { - * "/" Component } ; Component = ( [ PREFIX ] UNIT | - * "%" ) [ Annotation ] | Annotation | - * "1" ; Annotation = "{" NAME "}" - * ; Notes: Annotation is just a comment if it follows a UNIT and is - * equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, - * By{transmitted}/s == By/s. NAME is a sequence of non-blank printable - * ASCII characters not containing '{' or '}'. 1 represents - * dimensionless value 1, such as in 1/s. % represents dimensionless value - * 1/100, and annotates values giving a percentage. - */ - unit?: string; - /** - * Whether the measurement is an integer, a floating-point number, etc. Some - * combinations of metric_kind and value_type might not be supported. - */ - valueType?: string; - } - /** - * Additional annotations that can be used to guide the usage of a metric. - */ - export interface Schema$MetricDescriptorMetadata { - /** - * The delay of data points caused by ingestion. Data points older than this - * age are guaranteed to be ingested and available to be read, excluding - * data loss due to errors. - */ - ingestDelay?: string; - /** - * The launch stage of the metric definition. - */ - launchStage?: string; - /** - * The sampling period of metric data points. For metrics which are written - * periodically, consecutive data points are stored at this time interval, - * excluding data loss due to errors. Metrics with a higher granularity have - * a smaller sampling period. - */ - samplePeriod?: string; - } - /** - * An object representing a resource that can be used for monitoring, logging, - * billing, or other purposes. Examples include virtual machine instances, - * databases, and storage devices such as disks. The type field identifies a - * MonitoredResourceDescriptor object that describes the resource's - * schema. Information in the labels field identifies the actual resource and - * its attributes according to the schema. For example, a particular Compute - * Engine VM instance could be represented by the following object, because - * the MonitoredResourceDescriptor for "gce_instance" has labels - * "instance_id" and "zone": { "type": - * "gce_instance", "labels": { "instance_id": - * "12345678901234", "zone": - * "us-central1-a" }} - */ - export interface Schema$MonitoredResource { - /** - * Required. Values for all of the labels listed in the associated monitored - * resource descriptor. For example, Compute Engine VM instances use the - * labels "project_id", "instance_id", and - * "zone". - */ - labels?: {[key: string]: string;}; - /** - * Required. The monitored resource type. This field must match the type - * field of a MonitoredResourceDescriptor object. For example, the type of a - * Compute Engine VM instance is gce_instance. - */ - type?: string; - } - /** - * An object that describes the schema of a MonitoredResource object using a - * type name and a set of labels. For example, the monitored resource - * descriptor for Google Compute Engine VM instances has a type of - * "gce_instance" and specifies the use of the labels - * "instance_id" and "zone" to identify particular VM - * instances.Different APIs can support different monitored resource types. - * APIs generally provide a list method that returns the monitored resource - * descriptors used by the API. - */ - export interface Schema$MonitoredResourceDescriptor { - /** - * Optional. A detailed description of the monitored resource type that - * might be used in documentation. - */ - description?: string; - /** - * Optional. A concise name for the monitored resource type that might be - * displayed in user interfaces. It should be a Title Cased Noun Phrase, - * without any article or other determiners. For example, "Google Cloud - * SQL Database". - */ - displayName?: string; - /** - * Required. A set of labels used to describe instances of this monitored - * resource type. For example, an individual Google Cloud SQL database is - * identified by values for the labels "database_id" and - * "zone". - */ - labels?: Schema$LabelDescriptor[]; - /** - * Optional. The resource name of the monitored resource descriptor: - * "projects/{project_id}/monitoredResourceDescriptors/{type}" - * where {type} is the value of the type field in this object and - * {project_id} is a project ID that provides API-specific context for - * accessing the type. APIs that do not use project information can use the - * resource name format "monitoredResourceDescriptors/{type}". - */ - name?: string; - /** - * Required. The monitored resource type. For example, the type - * "cloudsql_database" represents databases in Google Cloud SQL. - * The maximum length of this value is 256 characters. - */ - type?: string; - } - /** - * Auxiliary metadata for a MonitoredResource object. MonitoredResource - * objects contain the minimum set of information to uniquely identify a - * monitored resource instance. There is some other useful auxiliary metadata. - * Monitoring and Logging use an ingestion pipeline to extract metadata for - * cloud resources of all types, and store the metadata in this message. - */ - export interface Schema$MonitoredResourceMetadata { - /** - * Output only. Values for predefined system metadata labels. System labels - * are a kind of metadata extracted by Google, including - * "machine_image", "vpc", "subnet_id", - * "security_group", "name", etc. System label values - * can be only strings, Boolean values, or a list of strings. For example: { - * "name": "my-test-instance", - * "security_group": ["a", "b", - * "c"], "spot_instance": false } - */ - systemLabels?: {[key: string]: any;}; - /** - * Output only. A map of user-defined metadata labels. - */ - userLabels?: {[key: string]: string;}; - } - /** - * Complete log information about a single HTTP request to an App Engine - * application. - */ - export interface Schema$RequestLog { - /** - * App Engine release version. - */ - appEngineRelease?: string; - /** - * Application that handled this request. - */ - appId?: string; - /** - * An indication of the relative cost of serving this request. - */ - cost?: number; - /** - * Time when the request finished. - */ - endTime?: string; - /** - * Whether this request is finished or active. - */ - finished?: boolean; - /** - * Whether this is the first RequestLog entry for this request. If an active - * request has several RequestLog entries written to Stackdriver Logging, - * then this field will be set for one of them. - */ - first?: boolean; - /** - * Internet host and port number of the resource being requested. - */ - host?: string; - /** - * HTTP version of request. Example: "HTTP/1.1". - */ - httpVersion?: string; - /** - * An identifier for the instance that handled the request. - */ - instanceId?: string; - /** - * If the instance processing this request belongs to a manually scaled - * module, then this is the 0-based index of the instance. Otherwise, this - * value is -1. - */ - instanceIndex?: number; - /** - * Origin IP address. - */ - ip?: string; - /** - * Latency of the request. - */ - latency?: string; - /** - * A list of log lines emitted by the application while serving this - * request. - */ - line?: Schema$LogLine[]; - /** - * Number of CPU megacycles used to process request. - */ - megaCycles?: string; - /** - * Request method. Example: "GET", "HEAD", - * "PUT", "POST", "DELETE". - */ - method?: string; - /** - * Module of the application that handled this request. - */ - moduleId?: string; - /** - * The logged-in user who made the request.Most likely, this is the part of - * the user's email before the @ sign. The field value is the same for - * different requests from the same user, but different users can have - * similar names. This information is also available to the application via - * the App Engine Users API.This field will be populated starting with App - * Engine 1.9.21. - */ - nickname?: string; - /** - * Time this request spent in the pending request queue. - */ - pendingTime?: string; - /** - * Referrer URL of request. - */ - referrer?: string; - /** - * Globally unique identifier for a request, which is based on the request - * start time. Request IDs for requests which started later will compare - * greater as strings than those for requests which started earlier. - */ - requestId?: string; - /** - * Contains the path and query portion of the URL that was requested. For - * example, if the URL was "http://example.com/app?name=val", the - * resource would be "/app?name=val". The fragment identifier, - * which is identified by the # character, is not included. - */ - resource?: string; - /** - * Size in bytes sent back to client by request. - */ - responseSize?: string; - /** - * Source code for the application that handled this request. There can be - * more than one source reference per deployed application if source code is - * distributed among multiple repositories. - */ - sourceReference?: Schema$SourceReference[]; - /** - * Time when the request started. - */ - startTime?: string; - /** - * HTTP response status code. Example: 200, 404. - */ - status?: number; - /** - * Task name of the request, in the case of an offline request. - */ - taskName?: string; - /** - * Queue name of the request, in the case of an offline request. - */ - taskQueueName?: string; - /** - * Stackdriver Trace identifier for this request. - */ - traceId?: string; - /** - * If true, the value in the 'trace_id' field was sampled for - * storage in a trace backend. - */ - traceSampled?: boolean; - /** - * File or class that handled the request. - */ - urlMapEntry?: string; - /** - * User agent that made the request. - */ - userAgent?: string; - /** - * Version of the application that handled this request. - */ - versionId?: string; - /** - * Whether this was a loading request for the instance. - */ - wasLoadingRequest?: boolean; - } - /** - * Specifies a location in a source code file. - */ - export interface Schema$SourceLocation { - /** - * Source file name. Depending on the runtime environment, this might be a - * simple name or a fully-qualified name. - */ - file?: string; - /** - * Human-readable name of the function or method being invoked, with - * optional context such as the class or package name. This information is - * used in contexts such as the logs viewer, where a file and line number - * are less meaningful. The format can vary by language. For example: - * qual.if.ied.Class.method (Java), dir/package.func (Go), function - * (Python). - */ - functionName?: string; - /** - * Line within the source file. - */ - line?: string; - } - /** - * A reference to a particular snapshot of the source tree used to build and - * deploy an application. - */ - export interface Schema$SourceReference { - /** - * Optional. A URI string identifying the repository. Example: - * "https://github.com/GoogleCloudPlatform/kubernetes.git" - */ - repository?: string; - /** - * The canonical and persistent identifier of the deployed revision. Example - * (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b" - */ - revisionId?: string; - } - /** - * The parameters to WriteLogEntries. - */ - export interface Schema$WriteLogEntriesRequest { - /** - * Optional. If true, the request should expect normal response, but the - * entries won't be persisted nor exported. Useful for checking whether - * the logging API endpoints are working properly before sending valuable - * data. - */ - dryRun?: boolean; - /** - * Required. The log entries to send to Logging. The order of log entries in - * this list does not matter. Values supplied in this method's log_name, - * resource, and labels fields are copied into those log entries in this - * list that do not include values for their corresponding fields. For more - * information, see the LogEntry type.If the timestamp or insert_id fields - * are missing in log entries, then this method supplies the current time or - * a unique identifier, respectively. The supplied values are chosen so - * that, among the log entries that did not supply their own values, the - * entries earlier in the list will sort before the entries later in the - * list. See the entries.list method.Log entries with timestamps that are - * more than the logs retention period in the past or more than 24 hours in - * the future will not be available when calling entries.list. However, - * those log entries can still be exported with LogSinks.To improve - * throughput and to avoid exceeding the quota limit for calls to - * entries.write, you should try to include several log entries in this - * list, rather than calling this method for each individual log entry. - */ - entries?: Schema$LogEntry[]; - /** - * Optional. Default labels that are added to the labels field of all log - * entries in entries. If a log entry already has a label with the same key - * as a label in this parameter, then the log entry's label is not - * changed. See LogEntry. - */ - labels?: {[key: string]: string;}; - /** - * Optional. A default log resource name that is assigned to all log entries - * in entries that do not specify a value for log_name: - * "projects/[PROJECT_ID]/logs/[LOG_ID]" - * "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" - * "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID] must be - * URL-encoded. For example: "projects/my-project-id/logs/syslog" - * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity" - * The permission <code>logging.logEntries.create</code> is - * needed on each project, organization, billing account, or folder that is - * receiving new log entries, whether the resource is specified in - * <code>logName</code> or in an individual log entry. - */ - logName?: string; - /** - * Optional. Whether valid entries should be written even if some other - * entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any - * entry is not written, then the response status is the error associated - * with one of the failed entries and the response includes error details - * keyed by the entries' zero-based index in the entries.write method. - */ - partialSuccess?: boolean; - /** - * Optional. A default monitored resource object that is assigned to all log - * entries in entries that do not specify a value for resource. Example: { - * "type": "gce_instance", "labels": { - * "zone": "us-central1-a", "instance_id": - * "00000000000000000000" }} See LogEntry. - */ - resource?: Schema$MonitoredResource; - } - /** - * Result returned from WriteLogEntries. empty - */ - export interface Schema$WriteLogEntriesResponse {} - - - export class Resource$Entries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - - /** - * logging.entries.list - * @desc Lists log entries. Use this method to retrieve log entries that - * originated from a project/folder/organization/billing account. For ways - * to export log entries, see Exporting Logs. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more 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 logging = google.logging('v2beta1'); - * - * 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 entriesPage = response['entries']; - * if (!entriesPage) { - * return; - * } - * for (var i = 0; i < entriesPage.length; i++) { - * // TODO: Change code below to process each resource in - * `entriesPage`: console.log(JSON.stringify(entriesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.resource.pageToken = response.nextPageToken; - * logging.entries.list(request, handlePage); - * } - * }; - * - * logging.entries.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 logging.entries.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {().ListLogEntriesRequest} 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$Entries$List, options?: MethodOptions): - GaxiosPromise; - list( - params: Params$Resource$Entries$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Entries$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Entries$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Entries$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Entries$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/entries:list') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * logging.entries.write - * @desc Writes log entries to Logging. This API method is the only way to - * send log entries to Logging. This method is used, directly or indirectly, - * by the Logging agent (fluentd) and all logging libraries configured to - * use Logging. A single request may contain log entries for a maximum of - * 1000 different resources (projects, organizations, billing accounts or - * folders) - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more 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 logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * logging.entries.write(request, function(err, response) { - * if (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 logging.entries.write - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {().WriteLogEntriesRequest} 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 - */ - write(params?: Params$Resource$Entries$Write, options?: MethodOptions): - GaxiosPromise; - write( - params: Params$Resource$Entries$Write, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - write( - params: Params$Resource$Entries$Write, - callback: BodyResponseCallback): void; - write(callback: BodyResponseCallback): void; - write( - paramsOrCallback?: Params$Resource$Entries$Write| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Entries$Write; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Entries$Write; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/entries:write') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Entries$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - - /** - * Request body metadata - */ - requestBody?: Schema$ListLogEntriesRequest; - } - export interface Params$Resource$Entries$Write extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - - /** - * Request body metadata - */ - requestBody?: Schema$WriteLogEntriesRequest; - } - - - export class Resource$Monitoredresourcedescriptors { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - - /** - * logging.monitoredResourceDescriptors.list - * @desc Lists the descriptors for monitored resource types used by Logging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more 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 logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var resourceDescriptorsPage = response['resourceDescriptors']; - * if (!resourceDescriptorsPage) { - * return; - * } - * for (var i = 0; i < resourceDescriptorsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `resourceDescriptorsPage`: - * console.log(JSON.stringify(resourceDescriptorsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * logging.monitoredResourceDescriptors.list(request, handlePage); - * } - * }; - * - * logging.monitoredResourceDescriptors.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 logging.monitoredResourceDescriptors.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - * @param {string=} params.pageToken Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - * @param {object} [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$Monitoredresourcedescriptors$List, - options?: MethodOptions): - GaxiosPromise; - list( - params: Params$Resource$Monitoredresourcedescriptors$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$ListMonitoredResourceDescriptorsResponse>): void; - list( - params: Params$Resource$Monitoredresourcedescriptors$List, - callback: BodyResponseCallback< - Schema$ListMonitoredResourceDescriptorsResponse>): void; - list(callback: BodyResponseCallback< - Schema$ListMonitoredResourceDescriptorsResponse>): void; - list( - paramsOrCallback?: Params$Resource$Monitoredresourcedescriptors$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$ListMonitoredResourceDescriptorsResponse>): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Monitoredresourcedescriptors$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Monitoredresourcedescriptors$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/monitoredResourceDescriptors') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.context - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest< - Schema$ListMonitoredResourceDescriptorsResponse>(parameters); - } - } - } - - export interface Params$Resource$Monitoredresourcedescriptors$List extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. - */ - pageToken?: string; - } - - - export class Resource$Projects { - context: APIRequestContext; - metrics: Resource$Projects$Metrics; - sinks: Resource$Projects$Sinks; - constructor(context: APIRequestContext) { - this.context = context; - this.metrics = new Resource$Projects$Metrics(this.context); - this.sinks = new Resource$Projects$Sinks(this.context); - } - } - - - export class Resource$Projects$Metrics { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - - /** - * logging.projects.metrics.create - * @desc Creates a logs-based metric. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more 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 logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * // The resource name of the project in which to create the metric: - * // "projects/[PROJECT_ID]" - * // The new metric must be provided in the request. - * parent: 'projects/my-project', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * logging.projects.metrics.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.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('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 logging.projects.metrics.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The resource name of the project in which to create the metric: "projects/[PROJECT_ID]" The new metric must be provided in the request. - * @param {().LogMetric} 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$Metrics$Create, - options?: MethodOptions): GaxiosPromise; - create( - params: Params$Resource$Projects$Metrics$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - create( - params: Params$Resource$Projects$Metrics$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: Params$Resource$Projects$Metrics$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Projects$Metrics$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Metrics$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/metrics') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * logging.projects.metrics.delete - * @desc Deletes a logs-based metric. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more 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 logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * // The resource name of the metric to delete: - * // "projects/[PROJECT_ID]/metrics/[METRIC_ID]" - * metricName: 'projects/my-project/metrics/my-metric', // TODO: Update - * placeholder value. - * - * auth: authClient, - * }; - * - * logging.projects.metrics.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 logging.projects.metrics.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.metricName The resource name of the metric to delete: "projects/[PROJECT_ID]/metrics/[METRIC_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$Projects$Metrics$Delete, - options?: MethodOptions): GaxiosPromise; - delete( - params: Params$Resource$Projects$Metrics$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Projects$Metrics$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Projects$Metrics$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Projects$Metrics$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Metrics$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+metricName}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['metricName'], - pathParams: ['metricName'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * logging.projects.metrics.get - * @desc Gets a logs-based metric. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more 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 logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * // The resource name of the desired metric: - * // "projects/[PROJECT_ID]/metrics/[METRIC_ID]" - * metricName: 'projects/my-project/metrics/my-metric', // TODO: Update - * placeholder value. - * - * auth: authClient, - * }; - * - * logging.projects.metrics.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 logging.projects.metrics.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.metricName The resource name of the desired metric: "projects/[PROJECT_ID]/metrics/[METRIC_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$Metrics$Get, - options?: MethodOptions): GaxiosPromise; - get(params: Params$Resource$Projects$Metrics$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Projects$Metrics$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Projects$Metrics$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Projects$Metrics$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Metrics$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+metricName}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['metricName'], - pathParams: ['metricName'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * logging.projects.metrics.list - * @desc Lists logs-based metrics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more 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 logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * // Required. The name of the project containing the metrics: - * // "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 metricsPage = response['metrics']; - * if (!metricsPage) { - * return; - * } - * for (var i = 0; i < metricsPage.length; i++) { - * // TODO: Change code below to process each resource in - * `metricsPage`: console.log(JSON.stringify(metricsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * logging.projects.metrics.list(request, handlePage); - * } - * }; - * - * logging.projects.metrics.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 logging.projects.metrics.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - * @param {string=} params.pageToken Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - * @param {string} params.parent Required. The name of the project containing the metrics: "projects/[PROJECT_ID]" - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Metrics$List, - options?: MethodOptions): GaxiosPromise; - list( - params: Params$Resource$Projects$Metrics$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Projects$Metrics$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Projects$Metrics$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Projects$Metrics$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Metrics$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/metrics') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * logging.projects.metrics.update - * @desc Creates or updates a logs-based metric. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more 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 logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * // The resource name of the metric to update: - * // "projects/[PROJECT_ID]/metrics/[METRIC_ID]" - * // The updated metric must be provided in the request and it's name - * field must be the same as - * // [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a - * new metric is created. metricName: - * 'projects/my-project/metrics/my-metric', // TODO: Update placeholder - * value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * logging.projects.metrics.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 logging.projects.metrics.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.metricName The resource name of the metric to update: "projects/[PROJECT_ID]/metrics/[METRIC_ID]" The updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created. - * @param {().LogMetric} 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$Projects$Metrics$Update, - options?: MethodOptions): GaxiosPromise; - update( - params: Params$Resource$Projects$Metrics$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Projects$Metrics$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Projects$Metrics$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Projects$Metrics$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Metrics$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+metricName}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['metricName'], - pathParams: ['metricName'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Metrics$Create extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The resource name of the project in which to create the metric: - * "projects/[PROJECT_ID]" The new metric must be provided in the request. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogMetric; - } - export interface Params$Resource$Projects$Metrics$Delete extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The resource name of the metric to delete: - * "projects/[PROJECT_ID]/metrics/[METRIC_ID]" - */ - metricName?: string; - } - export interface Params$Resource$Projects$Metrics$Get extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The resource name of the desired metric: - * "projects/[PROJECT_ID]/metrics/[METRIC_ID]" - */ - metricName?: string; - } - export interface Params$Resource$Projects$Metrics$List extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Required. The name of the project containing the metrics: - * "projects/[PROJECT_ID]" - */ - parent?: string; - } - export interface Params$Resource$Projects$Metrics$Update extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The resource name of the metric to update: - * "projects/[PROJECT_ID]/metrics/[METRIC_ID]" The updated metric must be - * provided in the request and it's name field must be the same as - * [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new - * metric is created. - */ - metricName?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogMetric; - } - - - export class Resource$Projects$Sinks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - - /** - * logging.projects.sinks.create - * @desc Creates a sink that exports specified log entries to a destination. - * The export of newly-ingested log entries begins immediately, unless the - * sink's writer_identity is not permitted to write to the destination. A - * sink can export log entries only from the resource owning the sink. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more 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 logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * // Required. The resource in which to create the sink: - * // "projects/[PROJECT_ID]" - * // "organizations/[ORGANIZATION_ID]" - * // "billingAccounts/[BILLING_ACCOUNT_ID]" - * // "folders/[FOLDER_ID]" - * // Examples: "projects/my-logging-project", - * "organizations/123456789". parent: 'projects/my-project', // TODO: - * Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * logging.projects.sinks.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.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('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 logging.projects.sinks.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". - * @param {boolean=} params.uniqueWriterIdentity Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. - * @param {().LogSink} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - create( - params?: Params$Resource$Projects$Sinks$Create, - options?: MethodOptions): GaxiosPromise; - create( - params: Params$Resource$Projects$Sinks$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - create( - params: Params$Resource$Projects$Sinks$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: Params$Resource$Projects$Sinks$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Projects$Sinks$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Sinks$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/sinks') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * logging.projects.sinks.delete - * @desc Deletes a sink. If the sink has a unique writer_identity, then that - * service account is also deleted. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more 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 logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * // Required. The full resource name of the sink to delete, including - * the parent resource and the sink - * // identifier: - * // "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * // "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * // "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * // "folders/[FOLDER_ID]/sinks/[SINK_ID]" - * // Example: "projects/my-project-id/sinks/my-sink-id". - * sinkName: 'projects/my-project/sinks/my-sink', // TODO: Update - * placeholder value. - * - * auth: authClient, - * }; - * - * logging.projects.sinks.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 logging.projects.sinks.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.sinkName Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-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$Projects$Sinks$Delete, - options?: MethodOptions): GaxiosPromise; - delete( - params: Params$Resource$Projects$Sinks$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Projects$Sinks$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Projects$Sinks$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Projects$Sinks$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Sinks$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+sinkName}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['sinkName'], - pathParams: ['sinkName'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * logging.projects.sinks.get - * @desc Gets a sink. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more 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 logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * // Required. The resource name of the sink: - * // "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * // "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * // "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * // "folders/[FOLDER_ID]/sinks/[SINK_ID]" - * // Example: "projects/my-project-id/sinks/my-sink-id". - * sinkName: 'projects/my-project/sinks/my-sink', // TODO: Update - * placeholder value. - * - * auth: authClient, - * }; - * - * logging.projects.sinks.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 logging.projects.sinks.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.sinkName Required. The resource name of the sink: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-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$Sinks$Get, - options?: MethodOptions): GaxiosPromise; - get(params: Params$Resource$Projects$Sinks$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Projects$Sinks$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Projects$Sinks$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Projects$Sinks$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Sinks$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+sinkName}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['sinkName'], - pathParams: ['sinkName'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * logging.projects.sinks.list - * @desc Lists sinks. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more 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 logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * // Required. The parent resource whose sinks are to be listed: - * // "projects/[PROJECT_ID]" - * // "organizations/[ORGANIZATION_ID]" - * // "billingAccounts/[BILLING_ACCOUNT_ID]" - * // "folders/[FOLDER_ID]" - * parent: 'projects/my-project', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var sinksPage = response['sinks']; - * if (!sinksPage) { - * return; - * } - * for (var i = 0; i < sinksPage.length; i++) { - * // TODO: Change code below to process each resource in `sinksPage`: - * console.log(JSON.stringify(sinksPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * logging.projects.sinks.list(request, handlePage); - * } - * }; - * - * logging.projects.sinks.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 logging.projects.sinks.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - * @param {string=} params.pageToken Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - * @param {string} params.parent Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list(params?: Params$Resource$Projects$Sinks$List, options?: MethodOptions): - GaxiosPromise; - list( - params: Params$Resource$Projects$Sinks$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Projects$Sinks$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Projects$Sinks$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Projects$Sinks$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Sinks$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+parent}/sinks') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * logging.projects.sinks.update - * @desc Updates a sink. This method replaces the following fields in the - * existing sink with values from the new sink: destination, and filter.The - * updated sink might also have a new writer_identity; see the - * unique_writer_identity field. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Stackdriver Logging API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/logging - * // 2. This sample uses Application Default Credentials for - * authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more 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 logging = google.logging('v2beta1'); - * - * authorize(function(authClient) { - * var request = { - * // Required. The full resource name of the sink to update, including - * the parent resource and the sink - * // identifier: - * // "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * // "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * // "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * // "folders/[FOLDER_ID]/sinks/[SINK_ID]" - * // Example: "projects/my-project-id/sinks/my-sink-id". - * sinkName: 'projects/my-project/sinks/my-sink', // TODO: Update - * placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing - * properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * logging.projects.sinks.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 logging.projects.sinks.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.sinkName Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: "projects/my-project-id/sinks/my-sink-id". - * @param {boolean=} params.uniqueWriterIdentity Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. - * @param {string=} params.updateMask Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter. - * @param {().LogSink} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - update( - params?: Params$Resource$Projects$Sinks$Update, - options?: MethodOptions): GaxiosPromise; - update( - params: Params$Resource$Projects$Sinks$Update, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - update( - params: Params$Resource$Projects$Sinks$Update, - callback: BodyResponseCallback): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: Params$Resource$Projects$Sinks$Update| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Projects$Sinks$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Sinks$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2beta1/{+sinkName}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['sinkName'], - pathParams: ['sinkName'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Sinks$Create extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The resource in which to create the sink: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: - * "projects/my-logging-project", "organizations/123456789". - */ - parent?: string; - /** - * Optional. Determines the kind of IAM identity returned as writer_identity - * in the new sink. If this value is omitted or set to false, and if the - * sink's parent is a project, then the value returned as writer_identity is - * the same group or service account used by Logging before the addition of - * writer identities to this API. The sink's destination must be in the same - * project as the sink itself.If this field is set to true, or if the sink - * is owned by a non-project resource such as an organization, then the - * value of writer_identity will be a unique service account used only for - * exports from the new sink. For more information, see writer_identity in - * LogSink. - */ - uniqueWriterIdentity?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$LogSink; - } - export interface Params$Resource$Projects$Sinks$Delete extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The full resource name of the sink to delete, including the - * parent resource and the sink identifier: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". - */ - sinkName?: string; - } - export interface Params$Resource$Projects$Sinks$Get extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The resource name of the sink: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". - */ - sinkName?: string; - } - export interface Params$Resource$Projects$Sinks$List extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Optional. The maximum number of results to return from this request. - * Non-positive values are ignored. The presence of nextPageToken in the - * response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the - * preceding call to this method. pageToken must be the value of - * nextPageToken from the previous response. The values of other method - * parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Required. The parent resource whose sinks are to be listed: - * "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" - */ - parent?: string; - } - export interface Params$Resource$Projects$Sinks$Update extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Required. The full resource name of the sink to update, including the - * parent resource and the sink identifier: - * "projects/[PROJECT_ID]/sinks/[SINK_ID]" - * "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" - * "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" - * "folders/[FOLDER_ID]/sinks/[SINK_ID]" Example: - * "projects/my-project-id/sinks/my-sink-id". - */ - sinkName?: string; - /** - * Optional. See sinks.create for a description of this field. When updating - * a sink, the effect of this field on the value of writer_identity in the - * updated sink depends on both the old and new values of this field: If the - * old and new values of this field are both false or both true, then there - * is no change to the sink's writer_identity. If the old value is false and - * the new value is true, then writer_identity is changed to a unique - * service account. It is an error if the old value is true and the new - * value is set to false or defaulted to false. - */ - uniqueWriterIdentity?: boolean; - /** - * Optional. Field mask that specifies the fields in sink that need an - * update. A sink field will be overwritten if, and only if, it is in the - * update mask. name and output only fields cannot be updated.An empty - * updateMask is temporarily treated as using the following mask for - * backwards compatibility purposes: destination,filter,includeChildren At - * some point in the future, behavior will be removed and specifying an - * empty updateMask will be an error.For a detailed FieldMask definition, - * see - * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: - * updateMask=filter. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogSink; - } -} diff --git a/src/apis/ml/v1.ts b/src/apis/ml/v1.ts index 79a8e8519bd..cbf09e909da 100644 --- a/src/apis/ml/v1.ts +++ b/src/apis/ml/v1.ts @@ -120,8 +120,8 @@ export namespace ml_v1 { * = 1; // The raw HTTP body is bound to this field. * google.api.HttpBody http_body = 2; } service ResourceService { rpc * GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - * UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - * Example with streaming methods: service CaldavService { rpc + * UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); + * } Example with streaming methods: service CaldavService { rpc * GetCalendar(stream google.api.HttpBody) returns (stream * google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) * returns (stream google.api.HttpBody); } Use of this type only changes @@ -203,20 +203,22 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__BuiltInAlgorithmOutput { /** - * Framework on which the built-in algorithm was trained on. + * Framework on which the built-in algorithm was trained. */ framework?: string; /** - * Built-in algorithm's saved model path. Only set for non-hptuning - * succeeded jobs. + * The Cloud Storage path to the `model/` directory where the training job + * saves the trained model. Only set for successful jobs that don't use + * hyperparameter tuning. */ modelPath?: string; /** - * Python version on which the built-in algorithm was trained on. + * Python version on which the built-in algorithm was trained. */ pythonVersion?: string; /** - * CMLE runtime version on which the built-in algorithm was trained on. + * Cloud ML Engine runtime version on which the built-in algorithm was + * trained. */ runtimeVersion?: string; } @@ -265,8 +267,8 @@ export namespace ml_v1 { allMetrics?: Schema$GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric[]; /** - * Details related to built-in algorithms job. Only set this for built-in - * algorithms jobs and for trials that succeeded. + * Details related to built-in algorithms jobs. Only set for trials of + * built-in algorithms jobs that have succeeded. */ builtInAlgorithmOutput?: Schema$GoogleCloudMlV1__BuiltInAlgorithmOutput; /** @@ -317,11 +319,11 @@ export namespace ml_v1 { */ hyperparameterMetricTag?: string; /** - * Optional. How many failed trials that need to be seen before failing the - * hyperparameter tuning job. User can specify this field to override the - * default failing criteria for CloudML Engine hyperparameter tuning jobs. - * Defaults to zero, which means to let the service decide 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 Cloud ML Engine hyperparameter tuning jobs. + * Defaults to zero, which means the service decides when a hyperparameter + * job should fail. */ maxFailedTrials?: number; /** @@ -351,7 +353,7 @@ export namespace ml_v1 { resumePreviousJobId?: string; } /** - * Represents a training, prediction or explanation job. + * Represents a training or prediction job. */ export interface Schema$GoogleCloudMlV1__Job { /** @@ -658,9 +660,9 @@ export namespace ml_v1 { */ dataFormat?: string; /** - * Required. The Google Cloud Storage location of the input data files. May - * contain wildcards. See <a - * href="https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames</a> + * Required. The Cloud Storage location of the input data files. May contain + * <a + * href="/storage/docs/gsutil/addlhelp/WildcardNames">wildcards</a>. */ inputPaths?: string[]; /** @@ -979,7 +981,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__TrainingOutput { /** - * Details related to built-in algorithms job. Only set for built-in + * Details related to built-in algorithms jobs. Only set for built-in * algorithms jobs. */ builtInAlgorithmOutput?: Schema$GoogleCloudMlV1__BuiltInAlgorithmOutput; @@ -1111,6 +1113,36 @@ export namespace ml_v1 { * 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. + */ + 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. + * """ + */ + predictionClass?: string; /** * Optional. The version of Python used in prediction. If not set, the * default version is '2.7'. Python '3.5' is available when @@ -1191,7 +1223,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleIamV1__Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/people/v1.ts b/src/apis/people/v1.ts index 39cf69e10b4..5af3fda9ed6 100644 --- a/src/apis/people/v1.ts +++ b/src/apis/people/v1.ts @@ -289,11 +289,20 @@ export namespace people_v1 { */ export interface Schema$ContactGroupMembership { /** - * The contact group ID for the contact group membership. The contact group - * ID can be custom or one of these predefined values: * `myContacts` * - * `starred` * A numerical ID for user-created groups. + * The read-only contact group ID for the contact group membership. */ contactGroupId?: string; + /** + * The resource name for the contact group, assigned by the server. An ASCII + * string, in the form of + * `contactGroups/`<var>contact_group_id</var>. Only + * contact_group_resource_name can be used for modifying memberships. Any + * contact group membership can be removed, but only user group or + * "myContacts" or "starred" system groups memberships + * can be added. A contact must always have at least one contact group + * membership. + */ + contactGroupResourceName?: string; } /** * The read-only metadata about a contact group. @@ -384,11 +393,11 @@ export namespace people_v1 { year?: number; } /** - * A Google Apps Domain membership. + * A read-only G Suite Domain membership. */ export interface Schema$DomainMembership { /** - * True if the person is in the viewer's Google Apps domain. + * True if the person is in the viewer's G Suite domain. */ inViewerDomain?: boolean; } @@ -602,7 +611,8 @@ export namespace people_v1 { value?: string; } /** - * A person's read-only membership in a group. + * A person's membership in a group. Only contact group memberships can be + * modified. */ export interface Schema$Membership { /** @@ -610,7 +620,7 @@ export namespace people_v1 { */ contactGroupMembership?: Schema$ContactGroupMembership; /** - * The domain membership. + * The read-only domain membership. */ domainMembership?: Schema$DomainMembership; /** @@ -621,7 +631,7 @@ export namespace people_v1 { /** * A request to modify an existing contact group's members. Contacts can * be removed from any group but they can only be added to a user group or - * myContacts or starred system groups. + * "myContacts" or "starred" system groups. */ export interface Schema$ModifyContactGroupMembersRequest { /** @@ -872,7 +882,7 @@ export namespace people_v1 { */ locales?: Schema$Locale[]; /** - * The person's read-only group memberships. + * The person's group memberships. */ memberships?: Schema$Membership[]; /** @@ -2280,7 +2290,7 @@ export namespace people_v1 { * * @param {object} params Parameters for request * @param {string} params.resourceName The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/`person_id. - * @param {string=} params.updatePersonFields **Required.** A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * emailAddresses * events * genders * imClients * interests * locales * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined + * @param {string=} params.updatePersonFields **Required.** A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * emailAddresses * events * genders * imClients * interests * locales * memberships * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined * @param {().Person} 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. @@ -2455,8 +2465,9 @@ export namespace people_v1 { * updated. Multiple fields can be specified by separating them with commas. * All updated fields will be replaced. Valid values are: * addresses * * biographies * birthdays * emailAddresses * events * genders * imClients * - * interests * locales * names * nicknames * occupations * organizations * - * phoneNumbers * relations * residences * sipAddresses * urls * userDefined + * interests * locales * memberships * names * nicknames * occupations * + * organizations * phoneNumbers * relations * residences * sipAddresses * + * urls * userDefined */ updatePersonFields?: string; diff --git a/src/apis/plusDomains/v1.ts b/src/apis/plusDomains/v1.ts index 6a4f6075b71..1c3e5114b6a 100644 --- a/src/apis/plusDomains/v1.ts +++ b/src/apis/plusDomains/v1.ts @@ -1754,76 +1754,6 @@ export namespace plusDomains_v1 { return createAPIRequest(parameters); } } - - - /** - * plusDomains.people.listByCircle - * @desc Shut down. See https://developers.google.com/+/api-shutdown for - * more details. - * @alias plusDomains.people.listByCircle - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.circleId The ID of the circle to get the members of. - * @param {integer=} params.maxResults The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. - * @param {string=} params.pageToken The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - listByCircle( - params?: Params$Resource$People$Listbycircle, - options?: MethodOptions): GaxiosPromise; - listByCircle( - params: Params$Resource$People$Listbycircle, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - listByCircle( - params: Params$Resource$People$Listbycircle, - callback: BodyResponseCallback): void; - listByCircle(callback: BodyResponseCallback): void; - listByCircle( - paramsOrCallback?: Params$Resource$People$Listbycircle| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$People$Listbycircle; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$People$Listbycircle; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/plusDomains/v1/circles/{circleId}/people') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['circleId'], - pathParams: ['circleId'], - context: this.context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } } export interface Params$Resource$People$Get extends StandardParameters { @@ -1898,28 +1828,4 @@ export namespace plusDomains_v1 { */ pageToken?: string; } - export interface Params$Resource$People$Listbycircle extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the circle to get the members of. - */ - circleId?: string; - /** - * The maximum number of people to include in the response, which is used - * for paging. For any response, the actual number returned might be less - * than the specified maxResults. - */ - maxResults?: number; - /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * "nextPageToken" from the previous response. - */ - pageToken?: string; - } } diff --git a/src/apis/poly/v1.ts b/src/apis/poly/v1.ts index 317cf2cf58c..a75a6821718 100644 --- a/src/apis/poly/v1.ts +++ b/src/apis/poly/v1.ts @@ -495,7 +495,7 @@ export namespace poly_v1 { * poly.assets.get * @desc Returns detailed information about an asset given its name. PRIVATE * assets are returned only if the currently authenticated user (via OAuth - * token) is the author of the asset. + * token) is the author of the asset. * @alias poly.assets.get * @memberOf! () * diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index adc5c54a767..11692c02010 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -122,10 +122,9 @@ export namespace pubsub_v1 { */ export interface Schema$Binding { /** - * Unimplemented. The condition that is associated with this binding. NOTE: - * an unsatisfied condition will not allow user access via current binding. - * Different bindings, including their conditions, are examined - * independently. + * The condition that is associated with this binding. NOTE: An unsatisfied + * condition will not allow user access via current binding. Different + * bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** diff --git a/src/apis/pubsub/v1beta2.ts b/src/apis/pubsub/v1beta2.ts index 1124ccb9f61..4a0682aa374 100644 --- a/src/apis/pubsub/v1beta2.ts +++ b/src/apis/pubsub/v1beta2.ts @@ -122,10 +122,9 @@ export namespace pubsub_v1beta2 { */ export interface Schema$Binding { /** - * Unimplemented. The condition that is associated with this binding. NOTE: - * an unsatisfied condition will not allow user access via current binding. - * Different bindings, including their conditions, are examined - * independently. + * The condition that is associated with this binding. NOTE: An unsatisfied + * condition will not allow user access via current binding. Different + * bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** diff --git a/src/apis/run/v1alpha1.ts b/src/apis/run/v1alpha1.ts index 075a531821a..1d0f343bcc2 100644 --- a/src/apis/run/v1alpha1.ts +++ b/src/apis/run/v1alpha1.ts @@ -191,7 +191,7 @@ export namespace run_v1alpha1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/runtimeconfig/v1beta1.ts b/src/apis/runtimeconfig/v1beta1.ts index fe84600fb02..c4bb14ef6c2 100644 --- a/src/apis/runtimeconfig/v1beta1.ts +++ b/src/apis/runtimeconfig/v1beta1.ts @@ -114,7 +114,7 @@ export namespace runtimeconfig_v1beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index 712ae37f974..d1616500738 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -361,6 +361,32 @@ export namespace securitycenter_v1 { * Request message for `GetIamPolicy` method. */ export interface Schema$GetIamPolicyRequest {} + /** + * 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; + } /** * Request message for grouping by assets. */ @@ -912,12 +938,13 @@ 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 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}])?. */ displayName?: string; /** diff --git a/src/apis/securitycenter/v1beta1.ts b/src/apis/securitycenter/v1beta1.ts index eb6552cdebb..9bf702f8704 100644 --- a/src/apis/securitycenter/v1beta1.ts +++ b/src/apis/securitycenter/v1beta1.ts @@ -359,6 +359,32 @@ export namespace securitycenter_v1beta1 { * Request message for `GetIamPolicy` method. */ export interface Schema$GetIamPolicyRequest {} + /** + * 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; + } /** * Request message for grouping by assets. */ diff --git a/src/apis/servicebroker/v1.ts b/src/apis/servicebroker/v1.ts index a87ea67e841..01739cf3244 100644 --- a/src/apis/servicebroker/v1.ts +++ b/src/apis/servicebroker/v1.ts @@ -113,7 +113,7 @@ export namespace servicebroker_v1 { */ export interface Schema$GoogleIamV1__Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/servicebroker/v1alpha1.ts b/src/apis/servicebroker/v1alpha1.ts index 308ae5ba8d5..8ce4841604b 100644 --- a/src/apis/servicebroker/v1alpha1.ts +++ b/src/apis/servicebroker/v1alpha1.ts @@ -537,7 +537,7 @@ export namespace servicebroker_v1alpha1 { */ export interface Schema$GoogleIamV1__Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/servicebroker/v1beta1.ts b/src/apis/servicebroker/v1beta1.ts index e822c8224da..2f131cd6744 100644 --- a/src/apis/servicebroker/v1beta1.ts +++ b/src/apis/servicebroker/v1beta1.ts @@ -610,7 +610,7 @@ export namespace servicebroker_v1beta1 { */ export interface Schema$GoogleIamV1__Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index 9afd5220fcf..f687d788a77 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -276,7 +276,7 @@ export namespace serviceconsumermanagement_v1 { provider?: string; } /** - * Configuration for an anthentication provider, including support for [JSON + * Configuration for an authentication provider, including support for [JSON * Web Token * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ @@ -2279,6 +2279,169 @@ export namespace serviceconsumermanagement_v1 { */ skipServiceControl?: boolean; } + /** + * Response message for the `AddVisibilityLabels` method. This response + * message is assigned to the `response` field of the returned Operation when + * that operation is done. + */ + export interface Schema$V1AddVisibilityLabelsResponse { + /** + * The updated set of visibility labels for this consumer on this service. + */ + labels?: string[]; + } + /** + * Response message for BatchCreateProducerOverrides + */ + export interface Schema$V1Beta1BatchCreateProducerOverridesResponse { + /** + * The overrides that were created. + */ + overrides?: Schema$V1Beta1QuotaOverride[]; + } + /** + * Response message for the `DisableConsumer` method. This response message is + * assigned to the `response` field of the returned Operation when that + * operation is done. + */ + export interface Schema$V1Beta1DisableConsumerResponse {} + /** + * Response message for the `EnableConsumer` method. This response message is + * assigned to the `response` field of the returned Operation when that + * operation is done. + */ + export interface Schema$V1Beta1EnableConsumerResponse {} + /** + * Response message for ImportProducerOverrides + */ + export interface Schema$V1Beta1ImportProducerOverridesResponse { + /** + * The overrides that were created from the imported data. + */ + overrides?: Schema$V1Beta1QuotaOverride[]; + } + /** + * A quota override + */ + export interface Schema$V1Beta1QuotaOverride { + /** + * If this map is nonempty, then this override applies only to specific + * values for dimensions defined in the limit unit. For example, an + * override on a limit with the unit 1/{project}/{region} could contain an + * entry with the key "region" and the value + * "us-east-1"; the override is only applied to quota consumed in + * that region. This map has the following restrictions: - Keys that are + * not defined in the limit's unit are not valid keys. Any string + * appearing in {brackets} in the unit (besides {project} or {user}) is a + * defined key. - "project" is not a valid key; the project is + * already specified in the parent resource name. - "user" is + * not a valid key; the API does not support quota overrides that apply + * only to a specific user. - If "region" appears as a key, its + * value must be a valid Cloud region. - If "zone" appears as a + * key, its value must be a valid Cloud zone. - If any valid key other than + * "region" or "zone" appears in the map, then all + * valid keys other than "region" or "zone" must also + * appear in the map. + */ + dimensions?: {[key: string]: string;}; + /** + * The name of the metric to which this override applies. An example name + * would be: `compute.googleapis.com/cpus` + */ + metric?: string; + /** + * The resource name of the producer override. An example name would be: + * `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` + */ + name?: string; + /** + * The overriding quota limit value. Can be any nonnegative integer, or -1 + * (unlimited quota). + */ + overrideValue?: string; + /** + * The limit unit of the limit to which this override applies. An example + * unit would be: `1/{project}/{region}` Note that `{project}` and + * `{region}` are not placeholders in this example; the literal characters + * `{` and `}` occur in the string. + */ + unit?: string; + } + /** + * Response message for the `RefreshConsumer` method. This response message is + * assigned to the `response` field of the returned Operation when that + * operation is done. + */ + export interface Schema$V1Beta1RefreshConsumerResponse {} + /** + * Response message for the `DisableConsumer` method. This response message is + * assigned to the `response` field of the returned Operation when that + * operation is done. + */ + export interface Schema$V1DisableConsumerResponse {} + /** + * Response message for the `EnableConsumer` method. This response message is + * assigned to the `response` field of the returned Operation when that + * operation is done. + */ + export interface Schema$V1EnableConsumerResponse {} + /** + * Response message for the `GenerateServiceAccount` method. This response + * message is assigned to the `response` field of the returned Operation when + * that operation is done. + */ + export interface Schema$V1GenerateServiceAccountResponse { + /** + * ServiceAccount that was created or retrieved. + */ + account?: Schema$V1ServiceAccount; + } + /** + * Response message for the `RefreshConsumer` method. This response message is + * assigned to the `response` field of the returned Operation when that + * operation is done. + */ + export interface Schema$V1RefreshConsumerResponse {} + /** + * Response message for the `RemoveVisibilityLabels` method. This response + * message is assigned to the `response` field of the returned Operation when + * that operation is done. + */ + export interface Schema$V1RemoveVisibilityLabelsResponse { + /** + * The updated set of visibility labels for this consumer on this service. + */ + labels?: string[]; + } + /** + * A service account in the Identity and Access Management API. + */ + export interface Schema$V1ServiceAccount { + /** + * The email address of the service account. + */ + email?: string; + /** + * The IAM resource name of the service account in the following format: + * projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. + */ + iamAccountName?: string; + /** + * P4 SA resource name. An example name would be: + * `services/serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default` + */ + name?: string; + /** + * The P4 SA configuration tag. This must be defined in activation_grants. + * If not specified when creating the account, the tag is set to + * "default". + */ + tag?: string; + /** + * The unique and stable id of the service account. + */ + uniqueId?: string; + } export class Resource$Operations { diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index fa1cb6eb014..5a558c78ecc 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -293,7 +293,7 @@ export namespace servicemanagement_v1 { provider?: string; } /** - * Configuration for an anthentication provider, including support for [JSON + * Configuration for an authentication provider, including support for [JSON * Web Token * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ @@ -455,7 +455,7 @@ export namespace servicemanagement_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied + * The condition that is associated with this binding. NOTE: An unsatisfied * condition will not allow user access via current binding. Different * bindings, including their conditions, are examined independently. */ @@ -518,8 +518,8 @@ export namespace servicemanagement_v1 { * '.' character. For repeated fields, an applicable unique * identifier field is used for the index (usually selector, name, or id). * For maps, the term 'key' is used. If the field has no unique - * identifier, the numeric index is used. ## Examples: - * visibility.rules[selector=="google.LibraryService.CreateBook"].restriction + * identifier, the numeric index is used. Examples: - + * visibility.rules[selector=="google.LibraryService.ListBooks"].restriction * - * quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value * - logging.producer_destinations[0] diff --git a/src/apis/servicenetworking/v1.ts b/src/apis/servicenetworking/v1.ts index b2dfd3f563f..ae82896cb63 100644 --- a/src/apis/servicenetworking/v1.ts +++ b/src/apis/servicenetworking/v1.ts @@ -284,7 +284,7 @@ export namespace servicenetworking_v1 { provider?: string; } /** - * Configuration for an anthentication provider, including support for [JSON + * Configuration for an authentication provider, including support for [JSON * Web Token * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index 2d6db3c4724..74dba2ca451 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -284,7 +284,7 @@ export namespace servicenetworking_v1beta { provider?: string; } /** - * Configuration for an anthentication provider, including support for [JSON + * Configuration for an authentication provider, including support for [JSON * Web Token * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index 084b41d15f1..930b68837b9 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -227,7 +227,7 @@ export namespace serviceusage_v1 { provider?: string; } /** - * Configuration for an anthentication provider, including support for [JSON + * Configuration for an authentication provider, including support for [JSON * Web Token * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ @@ -347,6 +347,24 @@ export namespace serviceusage_v1 { */ selector?: string; } + /** + * Response message for BatchCreateAdminOverrides + */ + export interface Schema$BatchCreateAdminOverridesResponse { + /** + * The overrides that were created. + */ + overrides?: Schema$QuotaOverride[]; + } + /** + * Response message for BatchCreateConsumerOverrides + */ + export interface Schema$BatchCreateConsumerOverridesResponse { + /** + * The overrides that were created. + */ + overrides?: Schema$QuotaOverride[]; + } /** * Request message for the `BatchEnableServices` method. */ @@ -1968,6 +1986,46 @@ export namespace serviceusage_v1 { */ values?: {[key: string]: string;}; } + /** + * A quota override + */ + export interface Schema$QuotaOverride { + /** + * If this map is nonempty, then this override applies only to specific + * values for dimensions defined in the limit unit. For example, an + * override on a limit with the unit 1/{project}/{region} could contain an + * entry with the key "region" and the value + * "us-east-1"; the override is only applied to quota consumed in + * that region. This map has the following restrictions: - Keys that are + * not defined in the limit's unit are not valid keys. Any string + * appearing in {brackets} in the unit (besides {project} or {user}) is a + * defined key. - "project" is not a valid key; the project is + * already specified in the parent resource name. - "user" is + * not a valid key; the API does not support quota overrides that apply + * only to a specific user. - If "region" appears as a key, its + * value must be a valid Cloud region. - If "zone" appears as a + * key, its value must be a valid Cloud zone. - If any valid key other than + * "region" or "zone" appears in the map, then all + * valid keys other than "region" or "zone" must also + * appear in the map. + */ + dimensions?: {[key: string]: string;}; + /** + * The resource name of the override. This name is generated by the server + * when the override is created. Example names would be: + * `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` + * `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` + * The resource name is intended to be opaque and should not be parsed for + * its component strings, since its representation could change in the + * future. + */ + name?: string; + /** + * The overriding quota limit value. Can be any nonnegative integer, or -1 + * (unlimited quota). + */ + overrideValue?: string; + } /** * `SourceContext` represents information about the source of a protobuf * element, like the file in which it is defined. diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index eed96c7f387..822376db65e 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -227,7 +227,7 @@ export namespace serviceusage_v1beta1 { provider?: string; } /** - * Configuration for an anthentication provider, including support for [JSON + * Configuration for an authentication provider, including support for [JSON * Web Token * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). */ @@ -347,6 +347,24 @@ export namespace serviceusage_v1beta1 { */ selector?: string; } + /** + * Response message for BatchCreateAdminOverrides + */ + export interface Schema$BatchCreateAdminOverridesResponse { + /** + * The overrides that were created. + */ + overrides?: Schema$QuotaOverride[]; + } + /** + * Response message for BatchCreateConsumerOverrides + */ + export interface Schema$BatchCreateConsumerOverridesResponse { + /** + * The overrides that were created. + */ + overrides?: Schema$QuotaOverride[]; + } /** * Request message for the `BatchEnableServices` method. */ @@ -1955,6 +1973,46 @@ export namespace serviceusage_v1beta1 { */ values?: {[key: string]: string;}; } + /** + * A quota override + */ + export interface Schema$QuotaOverride { + /** + * If this map is nonempty, then this override applies only to specific + * values for dimensions defined in the limit unit. For example, an + * override on a limit with the unit 1/{project}/{region} could contain an + * entry with the key "region" and the value + * "us-east-1"; the override is only applied to quota consumed in + * that region. This map has the following restrictions: - Keys that are + * not defined in the limit's unit are not valid keys. Any string + * appearing in {brackets} in the unit (besides {project} or {user}) is a + * defined key. - "project" is not a valid key; the project is + * already specified in the parent resource name. - "user" is + * not a valid key; the API does not support quota overrides that apply + * only to a specific user. - If "region" appears as a key, its + * value must be a valid Cloud region. - If "zone" appears as a + * key, its value must be a valid Cloud zone. - If any valid key other than + * "region" or "zone" appears in the map, then all + * valid keys other than "region" or "zone" must also + * appear in the map. + */ + dimensions?: {[key: string]: string;}; + /** + * The resource name of the override. This name is generated by the server + * when the override is created. Example names would be: + * `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` + * `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` + * The resource name is intended to be opaque and should not be parsed for + * its component strings, since its representation could change in the + * future. + */ + name?: string; + /** + * The overriding quota limit value. Can be any nonnegative integer, or -1 + * (unlimited quota). + */ + overrideValue?: string; + } /** * A service that is available for use by the consumer. */ diff --git a/src/apis/sourcerepo/v1.ts b/src/apis/sourcerepo/v1.ts index 7eab7672c16..96b89335eed 100644 --- a/src/apis/sourcerepo/v1.ts +++ b/src/apis/sourcerepo/v1.ts @@ -166,10 +166,9 @@ export namespace sourcerepo_v1 { */ export interface Schema$Binding { /** - * Unimplemented. The condition that is associated with this binding. NOTE: - * an unsatisfied condition will not allow user access via current binding. - * Different bindings, including their conditions, are examined - * independently. + * The condition that is associated with this binding. NOTE: An unsatisfied + * condition will not allow user access via current binding. Different + * bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index 0f6fc6e897f..dc32dbf34c6 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -138,8 +138,8 @@ export namespace spanner_v1 { * * `serviceAccount:{emailid}`: An email address that represents a service * account. For example, `my-other-app@appspot.gserviceaccount.com`. * * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins@example.com`. * `domain:{domain}`: A Google Apps - * domain name that represents all the users of that domain. For example, + * 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[]; @@ -272,7 +272,7 @@ export namespace spanner_v1 { instance?: Schema$Instance; /** * Required. The ID of the instance to create. Valid identifiers are of the - * form `a-z*[a-z0-9]` and must be between 6 and 30 characters in length. + * form `a-z*[a-z0-9]` and must be between 2 and 64 characters in length. */ instanceId?: string; } @@ -558,7 +558,7 @@ export namespace spanner_v1 { * Required. A unique identifier for the instance, which cannot be changed * after the instance is created. Values are of the form * `projects/<project>/instances/a-z*[a-z0-9]`. The final segment of - * the name must be between 6 and 30 characters in length. + * the name must be between 2 and 64 characters in length. */ name?: string; /** @@ -2483,7 +2483,7 @@ export namespace spanner_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 6 and 30 characters in length. + * @param {string} params.name Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. * @param {().UpdateInstanceRequest} 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 +2804,7 @@ export namespace spanner_v1 { * Required. A unique identifier for the instance, which cannot be changed * after the instance is created. Values are of the form * `projects//instances/a-z*[a-z0-9]`. The final segment of the - * name must be between 6 and 30 characters in length. + * name must be between 2 and 64 characters in length. */ name?: string; diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index 8e01591e2c4..02ec75edd89 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -458,6 +458,10 @@ export namespace sqladmin_v1beta4 { * The replicas of the instance. */ replicaNames?: string[]; + /** + * Initial root password. Use only on creation. + */ + rootPassword?: string; /** * The URI of this resource. */ diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index 3e903251b45..8f8493c65ae 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -459,6 +459,89 @@ export namespace storage_v1 { */ title?: string; } + /** + * JSON template to produce a JSON-style HMAC Key resource for Create + * responses. + */ + export interface Schema$HmacKey { + /** + * The kind of item this is. For HMAC keys, this is always storage#hmacKey. + */ + kind?: string; + /** + * Key metadata. + */ + metadata?: any; + /** + * HMAC secret key material. + */ + secret?: string; + } + /** + * JSON template to produce a JSON-style HMAC Key metadata resource. + */ + export interface Schema$HmacKeyMetadata { + /** + * The ID of the HMAC Key. + */ + accessId?: string; + /** + * HTTP 1.1 Entity tag for the access-control entry. + */ + etag?: string; + /** + * The ID of the HMAC key, including the Project ID and the Access ID. + */ + id?: string; + /** + * The kind of item this is. For HMAC Key metadata, this is always + * storage#hmacKeyMetadata. + */ + kind?: string; + /** + * Project ID owning the service account to which the key authenticates. + */ + projectId?: string; + /** + * The link to this resource. + */ + selfLink?: string; + /** + * The email address of the key's associated service account. + */ + serviceAccountEmail?: string; + /** + * The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED. + */ + state?: string; + /** + * The creation time of the HMAC key in RFC 3339 format. + */ + timeCreated?: string; + /** + * The last modification time of the HMAC key metadata in RFC 3339 format. + */ + updated?: string; + } + /** + * A list of hmacKeys. + */ + export interface Schema$HmacKeysMetadata { + /** + * The list of items. + */ + items?: Schema$HmacKeyMetadata[]; + /** + * The kind of item this is. For lists of hmacKeys, this is always + * storage#hmacKeysMetadata. + */ + kind?: string; + /** + * The continuation token, used to page through large result sets. Provide + * this value in a subsequent request to return the next page of results. + */ + nextPageToken?: string; + } /** * A subscription to receive Google PubSub notifications. */ @@ -8565,14 +8648,467 @@ export namespace storage_v1 { export class Resource$Projects { context: APIRequestContext; + hmacKeys: Resource$Projects$Hmackeys; serviceAccount: Resource$Projects$Serviceaccount; constructor(context: APIRequestContext) { this.context = context; + this.hmacKeys = new Resource$Projects$Hmackeys(this.context); this.serviceAccount = new Resource$Projects$Serviceaccount(this.context); } } + export class Resource$Projects$Hmackeys { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + + /** + * storage.projects.hmacKeys.create + * @desc Creates a new HMAC key for the specified service account. + * @alias storage.projects.hmacKeys.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.projectId Project ID owning the service account. + * @param {string} params.serviceAccountEmail Email address of the service account. + * @param {object} [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$Hmackeys$Create, + options?: MethodOptions): GaxiosPromise; + create( + params: Params$Resource$Projects$Hmackeys$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Projects$Hmackeys$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Projects$Hmackeys$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Hmackeys$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Hmackeys$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/storage/v1/projects/{projectId}/hmacKeys') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['projectId', 'serviceAccountEmail'], + pathParams: ['projectId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * storage.projects.hmacKeys.delete + * @desc Deletes an HMAC key. + * @alias storage.projects.hmacKeys.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.accessId Name of the HMAC key to be deleted. + * @param {string} params.projectId Project ID owning the requested key + * @param {object} [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$Hmackeys$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: Params$Resource$Projects$Hmackeys$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Projects$Hmackeys$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Projects$Hmackeys$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Hmackeys$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Hmackeys$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/storage/v1/projects/{projectId}/hmacKeys/{accessId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['projectId', 'accessId'], + pathParams: ['accessId', 'projectId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * storage.projects.hmacKeys.get + * @desc Retrieves an HMAC key's metadata + * @alias storage.projects.hmacKeys.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.accessId Name of the HMAC key. + * @param {string} params.projectId Project ID owning the service account of the requested key. + * @param {object} [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$Hmackeys$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Projects$Hmackeys$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Hmackeys$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Projects$Hmackeys$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Hmackeys$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Hmackeys$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/storage/v1/projects/{projectId}/hmacKeys/{accessId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['projectId', 'accessId'], + pathParams: ['accessId', 'projectId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * storage.projects.hmacKeys.list + * @desc Retrieves a list of HMAC keys matching the criteria. + * @alias storage.projects.hmacKeys.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.maxResults Maximum number of items plus prefixes to return in a single page of responses. Because duplicate prefixes are omitted, fewer total results may be returned than requested. The service uses this parameter or 1,000 items, whichever is smaller. + * @param {string=} params.pageToken A previously-returned page token representing part of the larger set of results to view. + * @param {string} params.projectId Name of the project in which to look for HMAC keys. + * @param {string=} params.serviceAccountEmail If present, only keys for the given service account are returned. + * @param {boolean=} params.showDeletedKeys Whether or not to show keys in the DELETED state. + * @param {object} [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$Hmackeys$List, + options?: MethodOptions): GaxiosPromise; + list( + params: Params$Resource$Projects$Hmackeys$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$Hmackeys$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Projects$Hmackeys$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Hmackeys$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Hmackeys$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/storage/v1/projects/{projectId}/hmacKeys') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['projectId'], + pathParams: ['projectId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * storage.projects.hmacKeys.update + * @desc Updates the state of an HMAC key. See the HMAC Key resource + * descriptor for valid states. + * @alias storage.projects.hmacKeys.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.accessId Name of the HMAC key being updated. + * @param {string} params.projectId Project ID owning the service account of the updated key. + * @param {().HmacKeyMetadata} 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$Projects$Hmackeys$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Projects$Hmackeys$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Projects$Hmackeys$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Projects$Hmackeys$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Hmackeys$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Hmackeys$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/storage/v1/projects/{projectId}/hmacKeys/{accessId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['projectId', 'accessId'], + pathParams: ['accessId', 'projectId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Hmackeys$Create extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID owning the service account. + */ + projectId?: string; + /** + * Email address of the service account. + */ + serviceAccountEmail?: string; + } + export interface Params$Resource$Projects$Hmackeys$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the HMAC key to be deleted. + */ + accessId?: string; + /** + * Project ID owning the requested key + */ + projectId?: string; + } + export interface Params$Resource$Projects$Hmackeys$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the HMAC key. + */ + accessId?: string; + /** + * Project ID owning the service account of the requested key. + */ + projectId?: string; + } + export interface Params$Resource$Projects$Hmackeys$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Maximum number of items plus prefixes to return in a single page of + * responses. Because duplicate prefixes are omitted, fewer total results + * may be returned than requested. The service uses this parameter or 1,000 + * items, whichever is smaller. + */ + maxResults?: number; + /** + * A previously-returned page token representing part of the larger set of + * results to view. + */ + pageToken?: string; + /** + * Name of the project in which to look for HMAC keys. + */ + projectId?: string; + /** + * If present, only keys for the given service account are returned. + */ + serviceAccountEmail?: string; + /** + * Whether or not to show keys in the DELETED state. + */ + showDeletedKeys?: boolean; + } + export interface Params$Resource$Projects$Hmackeys$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the HMAC key being updated. + */ + accessId?: string; + /** + * Project ID owning the service account of the updated key. + */ + projectId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HmacKeyMetadata; + } + + export class Resource$Projects$Serviceaccount { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/toolresults/v1beta3.ts b/src/apis/toolresults/v1beta3.ts index 5699bb8830a..3f4113b64f2 100644 --- a/src/apis/toolresults/v1beta3.ts +++ b/src/apis/toolresults/v1beta3.ts @@ -574,7 +574,16 @@ export namespace toolresults_v1beta3 { * other steps with the same configuration. */ export interface Schema$IndividualOutcome { + /** + * Unique int given to each step. Ranges from 0(inclusive) to total number + * of steps(exclusive). The primary step is 0. + */ + multistepNumber?: number; outcomeSummary?: string; + /** + * How long it took for this step to run. + */ + runDuration?: Schema$Duration; stepId?: string; } export interface Schema$ListExecutionsResponse { @@ -662,6 +671,16 @@ export namespace toolresults_v1beta3 { */ thumbnails?: Schema$Image[]; } + /** + * Response message for StepService.ListTestCases. + */ + export interface Schema$ListTestCasesResponse { + nextPageToken?: string; + /** + * List of test cases. + */ + testCases?: Schema$TestCase[]; + } export interface Schema$MemoryInfo { /** * Maximum memory that can be allocated to the process in KiB @@ -1138,6 +1157,42 @@ export namespace toolresults_v1beta3 { */ otherNativeCrash?: boolean; } + export interface Schema$TestCase { + /** + * The end time of the test case. Optional. + */ + endTime?: Schema$Timestamp; + /** + * Why the test case was skipped. Present only for skipped test case + */ + skippedMessage?: string; + /** + * The stack trace details if the test case failed or encountered an error. + * The maximum size of the stack traces is 100KiB, beyond which the stack + * track will be truncated. Zero if the test case passed. + */ + stackTraces?: Schema$StackTrace[]; + /** + * The start time of the test case. Optional. + */ + startTime?: Schema$Timestamp; + /** + * The status of the test case. Required. + */ + status?: string; + /** + * A unique identifier within a Step for this Test Case. + */ + testCaseId?: string; + /** + * Test case reference, e.g. name, class name and test suite name. Required. + */ + testCaseReference?: Schema$TestCaseReference; + /** + * References to opaque files of any format output by the tool execution. + */ + toolOutputs?: Schema$ToolOutputReference[]; + } /** * A reference to a test case. Test case references are canonically ordered * lexicographically by these three factors: * First, by test_suite_name. * @@ -2565,6 +2620,7 @@ export namespace toolresults_v1beta3 { Resource$Projects$Histories$Executions$Steps$Perfmetricssummary; perfSampleSeries: Resource$Projects$Histories$Executions$Steps$Perfsampleseries; + testCases: Resource$Projects$Histories$Executions$Steps$Testcases; thumbnails: Resource$Projects$Histories$Executions$Steps$Thumbnails; constructor(context: APIRequestContext) { this.context = context; @@ -2574,6 +2630,9 @@ export namespace toolresults_v1beta3 { this.perfSampleSeries = new Resource$Projects$Histories$Executions$Steps$Perfsampleseries( this.context); + this.testCases = + new Resource$Projects$Histories$Executions$Steps$Testcases( + this.context); this.thumbnails = new Resource$Projects$Histories$Executions$Steps$Thumbnails( this.context); @@ -3970,6 +4029,240 @@ export namespace toolresults_v1beta3 { + export class Resource$Projects$Histories$Executions$Steps$Testcases { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + + /** + * toolresults.projects.histories.executions.steps.testCases.get + * @desc Gets details of a Test Case for a Step. Experimental test cases + * API. Still in active development. May return any of the following + * canonical error codes: - PERMISSION_DENIED - if the user is not + * authorized to write to project - INVALID_ARGUMENT - if the request is + * malformed - NOT_FOUND - if the containing Test Case does not exist + * @alias toolresults.projects.histories.executions.steps.testCases.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.executionId A Execution id Required. + * @param {string} params.historyId A History id. Required. + * @param {string} params.projectId A Project id. Required. + * @param {string} params.stepId A Step id. Note: This step must include a TestExecutionStep. Required. + * @param {string} params.testCaseId A Test Case id. Required. + * @param {object} [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$Histories$Executions$Steps$Testcases$Get, + options?: MethodOptions): GaxiosPromise; + get(params: + Params$Resource$Projects$Histories$Executions$Steps$Testcases$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: + Params$Resource$Projects$Histories$Executions$Steps$Testcases$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: + Params$Resource$Projects$Histories$Executions$Steps$Testcases$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Histories$Executions$Steps$Testcases$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Histories$Executions$Steps$Testcases$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases/{testCaseId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: + ['projectId', 'historyId', 'executionId', 'stepId', 'testCaseId'], + pathParams: + ['executionId', 'historyId', 'projectId', 'stepId', 'testCaseId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * toolresults.projects.histories.executions.steps.testCases.list + * @desc Lists Test Cases attached to a Step. Experimental test cases API. + * Still in active development. May return any of the following canonical + * error codes: - PERMISSION_DENIED - if the user is not authorized to + * write to project - INVALID_ARGUMENT - if the request is malformed - + * NOT_FOUND - if the containing Step does not exist + * @alias toolresults.projects.histories.executions.steps.testCases.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.executionId A Execution id Required. + * @param {string} params.historyId A History id. Required. + * @param {integer=} params.pageSize The maximum number of TestCases to fetch. Default value: 100. The server will use this default if the field is not set or has a value of 0. Optional. + * @param {string=} params.pageToken A continuation token to resume the query at the next item. Optional. + * @param {string} params.projectId A Project id. Required. + * @param {string} params.stepId A Step id. Note: This step must include a TestExecutionStep. Required. + * @param {object} [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$Histories$Executions$Steps$Testcases$List, + options?: MethodOptions): GaxiosPromise; + list( + params: + Params$Resource$Projects$Histories$Executions$Steps$Testcases$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: + Params$Resource$Projects$Histories$Executions$Steps$Testcases$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + Params$Resource$Projects$Histories$Executions$Steps$Testcases$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Histories$Executions$Steps$Testcases$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Histories$Executions$Steps$Testcases$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['projectId', 'historyId', 'executionId', 'stepId'], + pathParams: ['executionId', 'historyId', 'projectId', 'stepId'], + context: this.context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Histories$Executions$Steps$Testcases$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A Execution id Required. + */ + executionId?: string; + /** + * A History id. Required. + */ + historyId?: string; + /** + * A Project id. Required. + */ + projectId?: string; + /** + * A Step id. Note: This step must include a TestExecutionStep. Required. + */ + stepId?: string; + /** + * A Test Case id. Required. + */ + testCaseId?: string; + } + export interface Params$Resource$Projects$Histories$Executions$Steps$Testcases$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A Execution id Required. + */ + executionId?: string; + /** + * A History id. Required. + */ + historyId?: string; + /** + * The maximum number of TestCases to fetch. Default value: 100. The server + * will use this default if the field is not set or has a value of 0. + * Optional. + */ + pageSize?: number; + /** + * A continuation token to resume the query at the next item. Optional. + */ + pageToken?: string; + /** + * A Project id. Required. + */ + projectId?: string; + /** + * A Step id. Note: This step must include a TestExecutionStep. Required. + */ + stepId?: string; + } + + export class Resource$Projects$Histories$Executions$Steps$Thumbnails { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/vault/v1.ts b/src/apis/vault/v1.ts index 315d8f73ec9..8b2e23fbcf1 100644 --- a/src/apis/vault/v1.ts +++ b/src/apis/vault/v1.ts @@ -409,9 +409,22 @@ export namespace vault_v1 { */ accountId?: string; /** - * When the account was put on hold. + * The primary email address of the account. If used as an input, this takes + * precedence over account ID. + */ + email?: string; + /** + * Output only. The first name of the account holder. + */ + firstName?: string; + /** + * Output only. When the account was put on hold. */ holdTime?: string; + /** + * Output only. The last name of the account holder. + */ + lastName?: string; } /** * Query options for Drive holds. diff --git a/src/apis/vision/v1.ts b/src/apis/vision/v1.ts index 548330d2a82..23297120622 100644 --- a/src/apis/vision/v1.ts +++ b/src/apis/vision/v1.ts @@ -715,16 +715,22 @@ export namespace vision_v1 { */ export interface Schema$GcsDestination { /** - * Google Cloud Storage URI where the results will be stored. Results will - * be in JSON format and preceded by its corresponding input URI. This field - * can either represent a single file, or a prefix for multiple outputs. - * Prefixes must end in a `/`. Examples: * File: - * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ - * * File: gs://bucket-name/prefix/here 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. + * 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; } @@ -1099,16 +1105,22 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1GcsDestination { /** - * Google Cloud Storage URI where the results will be stored. Results will - * be in JSON format and preceded by its corresponding input URI. This field - * can either represent a single file, or a prefix for multiple outputs. - * Prefixes must end in a `/`. Examples: * File: - * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ - * * File: gs://bucket-name/prefix/here 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. + * 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; } @@ -1377,8 +1389,9 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Changes made after - * this time are not reflected in the current results. + * 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; /** @@ -2084,16 +2097,22 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1GcsDestination { /** - * Google Cloud Storage URI where the results will be stored. Results will - * be in JSON format and preceded by its corresponding input URI. This field - * can either represent a single file, or a prefix for multiple outputs. - * Prefixes must end in a `/`. Examples: * File: - * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ - * * File: gs://bucket-name/prefix/here 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. + * 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; } @@ -2362,8 +2381,9 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Changes made after - * this time are not reflected in the current results. + * 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; /** @@ -3089,16 +3109,22 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1GcsDestination { /** - * Google Cloud Storage URI where the results will be stored. Results will - * be in JSON format and preceded by its corresponding input URI. This field - * can either represent a single file, or a prefix for multiple outputs. - * Prefixes must end in a `/`. Examples: * File: - * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ - * * File: gs://bucket-name/prefix/here 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. + * 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; } @@ -3385,8 +3411,9 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Changes made after - * this time are not reflected in the current results. + * 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; /** @@ -4161,16 +4188,22 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1GcsDestination { /** - * Google Cloud Storage URI where the results will be stored. Results will - * be in JSON format and preceded by its corresponding input URI. This field - * can either represent a single file, or a prefix for multiple outputs. - * Prefixes must end in a `/`. Examples: * File: - * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ - * * File: gs://bucket-name/prefix/here 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. + * 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; } @@ -4465,8 +4498,9 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Changes made after - * this time are not reflected in the current results. + * 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; /** @@ -5425,9 +5459,11 @@ export namespace vision_v1 { * The filtering expression. This can be used to restrict search results * based on Product labels. We currently support an AND of OR of key-value * expressions, where each expression within an OR must have the same key. - * For example, "(color = red OR color = blue) AND brand = Google" - * is acceptable, but not "(color = red OR brand = Google)" or - * "color: red". + * An '=' should be used to connect the key and value. For example, + * "(color = red OR color = blue) AND brand = Google" is + * acceptable, but "(color = red OR brand = Google)" is not + * acceptable. "color: red" is not acceptable because it uses a + * ':' instead of an '='. */ filter?: string; /** @@ -5448,8 +5484,9 @@ export namespace vision_v1 { */ export interface Schema$ProductSearchResults { /** - * Timestamp of the index which provided these results. Changes made after - * this time are not reflected in the current results. + * 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; /** @@ -6565,19 +6602,24 @@ export namespace vision_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); } } export class Resource$Projects$Locations { context: APIRequestContext; + operations: Resource$Projects$Locations$Operations; products: Resource$Projects$Locations$Products; productSets: Resource$Projects$Locations$Productsets; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Operations(this.context); this.products = new Resource$Projects$Locations$Products(this.context); this.productSets = new Resource$Projects$Locations$Productsets(this.context); @@ -6585,6 +6627,91 @@ export namespace vision_v1 { } + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + + /** + * 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. + * @alias vision.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://vision.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$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 class Resource$Projects$Locations$Products { context: APIRequestContext; referenceImages: Resource$Projects$Locations$Products$Referenceimages; @@ -6673,8 +6800,7 @@ export namespace vision_v1 { * @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. Possible errors: * Returns NOT_FOUND - * if the product does not exist. + * all related caches are refreshed. Possible errors: none * @alias vision.projects.locations.products.delete * @memberOf! () * @@ -7142,7 +7268,7 @@ export namespace vision_v1 { * 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. Possible errors: - * * Returns NOT_FOUND if the reference image does not exist. + * none * @alias vision.projects.locations.products.referenceImages.delete * @memberOf! () * @@ -7593,8 +7719,7 @@ 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. Possible errors: * Returns NOT_FOUND if the - * ProductSet does not exist. + * from Google Cloud Storage. Possible errors: none * @alias vision.projects.locations.productSets.delete * @memberOf! () * @@ -7908,7 +8033,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Productsets$Import| /** * vision.projects.locations.productSets.removeProduct * @desc Removes a Product from the specified ProductSet. Possible errors: - * * Returns NOT_FOUND If the Product is not found under the ProductSet. + * none * @alias vision.projects.locations.productSets.removeProduct * @memberOf! () * @@ -8240,4 +8365,90 @@ import(paramsOrCallback?: Params$Resource$Projects$Locations$Productsets$Import| */ pageToken?: string; } + + + + export class Resource$Projects$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + + /** + * 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. + * @alias vision.projects.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$Operations$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Projects$Operations$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Operations$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Projects$Operations$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vision.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$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; + } } diff --git a/src/apis/vision/v1p1beta1.ts b/src/apis/vision/v1p1beta1.ts index 79c9bacc6a2..1c808e6d4f5 100644 --- a/src/apis/vision/v1p1beta1.ts +++ b/src/apis/vision/v1p1beta1.ts @@ -584,16 +584,22 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GcsDestination { /** - * Google Cloud Storage URI where the results will be stored. Results will - * be in JSON format and preceded by its corresponding input URI. This field - * can either represent a single file, or a prefix for multiple outputs. - * Prefixes must end in a `/`. Examples: * File: - * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ - * * File: gs://bucket-name/prefix/here 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. + * 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; } @@ -1071,16 +1077,22 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1GcsDestination { /** - * Google Cloud Storage URI where the results will be stored. Results will - * be in JSON format and preceded by its corresponding input URI. This field - * can either represent a single file, or a prefix for multiple outputs. - * Prefixes must end in a `/`. Examples: * File: - * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ - * * File: gs://bucket-name/prefix/here 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. + * 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; } @@ -1447,9 +1459,11 @@ export namespace vision_v1p1beta1 { * The filtering expression. This can be used to restrict search results * based on Product labels. We currently support an AND of OR of key-value * expressions, where each expression within an OR must have the same key. - * For example, "(color = red OR color = blue) AND brand = Google" - * is acceptable, but not "(color = red OR brand = Google)" or - * "color: red". + * An '=' should be used to connect the key and value. For example, + * "(color = red OR color = blue) AND brand = Google" is + * acceptable, but "(color = red OR brand = Google)" is not + * acceptable. "color: red" is not acceptable because it uses a + * ':' instead of an '='. */ filter?: string; /** @@ -1470,8 +1484,9 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Changes made after - * this time are not reflected in the current results. + * 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; /** @@ -2186,16 +2201,22 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1GcsDestination { /** - * Google Cloud Storage URI where the results will be stored. Results will - * be in JSON format and preceded by its corresponding input URI. This field - * can either represent a single file, or a prefix for multiple outputs. - * Prefixes must end in a `/`. Examples: * File: - * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ - * * File: gs://bucket-name/prefix/here 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. + * 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; } @@ -2464,8 +2485,9 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Changes made after - * this time are not reflected in the current results. + * 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; /** @@ -3191,16 +3213,22 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1GcsDestination { /** - * Google Cloud Storage URI where the results will be stored. Results will - * be in JSON format and preceded by its corresponding input URI. This field - * can either represent a single file, or a prefix for multiple outputs. - * Prefixes must end in a `/`. Examples: * File: - * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ - * * File: gs://bucket-name/prefix/here 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. + * 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; } @@ -3487,8 +3515,9 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Changes made after - * this time are not reflected in the current results. + * 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; /** @@ -4263,16 +4292,22 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1GcsDestination { /** - * Google Cloud Storage URI where the results will be stored. Results will - * be in JSON format and preceded by its corresponding input URI. This field - * can either represent a single file, or a prefix for multiple outputs. - * Prefixes must end in a `/`. Examples: * File: - * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ - * * File: gs://bucket-name/prefix/here 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. + * 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; } @@ -4567,8 +4602,9 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Changes made after - * this time are not reflected in the current results. + * 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; /** @@ -5295,8 +5331,9 @@ export namespace vision_v1p1beta1 { */ export interface Schema$ProductSearchResults { /** - * Timestamp of the index which provided these results. Changes made after - * this time are not reflected in the current results. + * 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; /** diff --git a/src/apis/vision/v1p2beta1.ts b/src/apis/vision/v1p2beta1.ts index be8da724e53..d7acf87bcfe 100644 --- a/src/apis/vision/v1p2beta1.ts +++ b/src/apis/vision/v1p2beta1.ts @@ -584,16 +584,22 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GcsDestination { /** - * Google Cloud Storage URI where the results will be stored. Results will - * be in JSON format and preceded by its corresponding input URI. This field - * can either represent a single file, or a prefix for multiple outputs. - * Prefixes must end in a `/`. Examples: * File: - * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ - * * File: gs://bucket-name/prefix/here 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. + * 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; } @@ -968,16 +974,22 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1GcsDestination { /** - * Google Cloud Storage URI where the results will be stored. Results will - * be in JSON format and preceded by its corresponding input URI. This field - * can either represent a single file, or a prefix for multiple outputs. - * Prefixes must end in a `/`. Examples: * File: - * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ - * * File: gs://bucket-name/prefix/here 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. + * 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; } @@ -1246,8 +1258,9 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Changes made after - * this time are not reflected in the current results. + * 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; /** @@ -2056,16 +2069,22 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1GcsDestination { /** - * Google Cloud Storage URI where the results will be stored. Results will - * be in JSON format and preceded by its corresponding input URI. This field - * can either represent a single file, or a prefix for multiple outputs. - * Prefixes must end in a `/`. Examples: * File: - * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ - * * File: gs://bucket-name/prefix/here 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. + * 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; } @@ -2432,9 +2451,11 @@ export namespace vision_v1p2beta1 { * The filtering expression. This can be used to restrict search results * based on Product labels. We currently support an AND of OR of key-value * expressions, where each expression within an OR must have the same key. - * For example, "(color = red OR color = blue) AND brand = Google" - * is acceptable, but not "(color = red OR brand = Google)" or - * "color: red". + * An '=' should be used to connect the key and value. For example, + * "(color = red OR color = blue) AND brand = Google" is + * acceptable, but "(color = red OR brand = Google)" is not + * acceptable. "color: red" is not acceptable because it uses a + * ':' instead of an '='. */ filter?: string; /** @@ -2455,8 +2476,9 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Changes made after - * this time are not reflected in the current results. + * 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; /** @@ -3191,16 +3213,22 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1GcsDestination { /** - * Google Cloud Storage URI where the results will be stored. Results will - * be in JSON format and preceded by its corresponding input URI. This field - * can either represent a single file, or a prefix for multiple outputs. - * Prefixes must end in a `/`. Examples: * File: - * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ - * * File: gs://bucket-name/prefix/here 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. + * 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; } @@ -3487,8 +3515,9 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Changes made after - * this time are not reflected in the current results. + * 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; /** @@ -4263,16 +4292,22 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1GcsDestination { /** - * Google Cloud Storage URI where the results will be stored. Results will - * be in JSON format and preceded by its corresponding input URI. This field - * can either represent a single file, or a prefix for multiple outputs. - * Prefixes must end in a `/`. Examples: * File: - * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ - * * File: gs://bucket-name/prefix/here 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. + * 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; } @@ -4567,8 +4602,9 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResults { /** - * Timestamp of the index which provided these results. Changes made after - * this time are not reflected in the current results. + * 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; /** @@ -5295,8 +5331,9 @@ export namespace vision_v1p2beta1 { */ export interface Schema$ProductSearchResults { /** - * Timestamp of the index which provided these results. Changes made after - * this time are not reflected in the current results. + * 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; /** diff --git a/src/index.ts b/src/index.ts index 735100025d5..09841e5ce96 100644 --- a/src/index.ts +++ b/src/index.ts @@ -22,6 +22,7 @@ export {google, GoogleApis}; export {abusiveexperiencereport_v1} from './apis/abusiveexperiencereport/v1'; export {acceleratedmobilepageurl_v1} from './apis/acceleratedmobilepageurl/v1'; +export {accessapproval_v1beta1} from './apis/accessapproval/v1beta1'; export {accesscontextmanager_v1} from './apis/accesscontextmanager/v1'; export {accesscontextmanager_v1beta} from './apis/accesscontextmanager/v1beta'; export {adexchangebuyer_v1_2} from './apis/adexchangebuyer/v1.2'; @@ -82,6 +83,7 @@ export {cloudresourcemanager_v1} from './apis/cloudresourcemanager/v1'; export {cloudresourcemanager_v1beta1} from './apis/cloudresourcemanager/v1beta1'; export {cloudresourcemanager_v2} from './apis/cloudresourcemanager/v2'; export {cloudresourcemanager_v2beta1} from './apis/cloudresourcemanager/v2beta1'; +export {cloudscheduler_v1} from './apis/cloudscheduler/v1'; export {cloudscheduler_v1beta1} from './apis/cloudscheduler/v1beta1'; export {cloudsearch_v1} from './apis/cloudsearch/v1'; export {cloudshell_v1} from './apis/cloudshell/v1'; @@ -91,6 +93,7 @@ export {cloudtasks_v2beta2} from './apis/cloudtasks/v2beta2'; export {cloudtasks_v2beta3} from './apis/cloudtasks/v2beta3'; export {cloudtrace_v1} from './apis/cloudtrace/v1'; export {cloudtrace_v2} from './apis/cloudtrace/v2'; +export {commentanalyzer_v1alpha1} from './apis/commentanalyzer/v1alpha1'; export {composer_v1} from './apis/composer/v1'; export {composer_v1beta1} from './apis/composer/v1beta1'; export {compute_alpha} from './apis/compute/alpha'; @@ -169,7 +172,6 @@ export {language_v1beta2} from './apis/language/v1beta2'; export {libraryagent_v1} from './apis/libraryagent/v1'; export {licensing_v1} from './apis/licensing/v1'; export {logging_v2} from './apis/logging/v2'; -export {logging_v2beta1} from './apis/logging/v2beta1'; export {manufacturers_v1} from './apis/manufacturers/v1'; export {mirror_v1} from './apis/mirror/v1'; export {ml_v1} from './apis/ml/v1';